From 53ded83c580f64d1b17daccc08b3ad0605b915f5 Mon Sep 17 00:00:00 2001 From: alexcoder04 Date: Fri, 17 Feb 2023 22:06:33 +0100 Subject: [PATCH] rename project --- .gitignore | 2 +- Makefile | 2 +- README.md | 49 ++++++++---------- config.go | 4 +- docs/Configuration.md | 10 ++-- docs/Installation.md | 8 +-- docs/Setting-Up.md | 6 +-- docs/index.md | 16 +++--- go.mod | 2 +- kherson.1 => i3gocks.1 | 12 ++--- ...ult.png => screenshot-i3gocks-default.png} | Bin ... => screenshot-i3gocks-dracula-blocks.png} | Bin ....png => screenshot-i3gocks-dracula-my.png} | Bin ...y.png => screenshot-i3gocks-macwal-my.png} | Bin ...erson-my.png => screenshot-i3gocks-my.png} | Bin ...enshot-i3gocks-powerline-oceanic-next.png} | Bin 16 files changed, 52 insertions(+), 59 deletions(-) rename kherson.1 => i3gocks.1 (51%) rename screenshots/{screenshot-kherson-default.png => screenshot-i3gocks-default.png} (100%) rename screenshots/{screenshot-kherson-dracula-blocks.png => screenshot-i3gocks-dracula-blocks.png} (100%) rename screenshots/{screenshot-kherson-dracula-my.png => screenshot-i3gocks-dracula-my.png} (100%) rename screenshots/{screenshot-kherson-macwal-my.png => screenshot-i3gocks-macwal-my.png} (100%) rename screenshots/{screenshot-kherson-my.png => screenshot-i3gocks-my.png} (100%) rename screenshots/{screenshot-kherson-powerline-oceanic-next.png => screenshot-i3gocks-powerline-oceanic-next.png} (100%) diff --git a/.gitignore b/.gitignore index 487c4bf..9a16b94 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,7 @@ *.dll *.so *.dylib -kherson +i3gocks # Test binary, built with `go test -c` *.test diff --git a/Makefile b/Makefile index 142aebb..6944fae 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ SHELL = /bin/sh PREFIX ?= /usr -NAME = kherson +NAME = i3gocks build: GOOS=linux GOARCH=amd64 go build -o $(NAME) . diff --git a/README.md b/README.md index f2a8439..16137ac 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,19 @@ -[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua) - -On 24 February 2022 Russia invaded Ukraine and is killing thousands of innocent -civilians. This has to stop! I named my new project after -[Kherson](https://en.wikipedia.org/wiki/Kherson), a city in the south of -Ukraine, to draw attention to this inacceptable issue. - -*Update 11.11.2022:* Kherson is Ukrainian ~~again~~ as it always was. - ---- - -# kherson - -screenshot 1 -screenshot 2 -screenshot 3 -screenshot 4 -screenshot 5 -screenshot 6 - -[![Release](https://img.shields.io/github/v/release/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/releases/latest) -[![AUR](https://img.shields.io/aur/version/kherson)](https://aur.archlinux.org/packages/kherson) -[![Top language](https://img.shields.io/github/languages/top/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/search?l=go) -[![License](https://img.shields.io/github/license/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/blob/main/LICENSE) -[![Issues](https://img.shields.io/github/issues/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/issues) -[![Pull requests](https://img.shields.io/github/issues-pr/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/pulls) +# i3gocks + +screenshot 1 +screenshot 2 +screenshot 3 +screenshot 4 +screenshot 5 +screenshot 6 + +[![Release](https://img.shields.io/github/v/release/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/releases/latest) +[![AUR](https://img.shields.io/aur/version/i3gocks)](https://aur.archlinux.org/packages/i3gocks) +[![Top language](https://img.shields.io/github/languages/top/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/search?l=go) +[![License](https://img.shields.io/github/license/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/blob/main/LICENSE) +[![Issues](https://img.shields.io/github/issues/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/issues) +[![Pull requests](https://img.shields.io/github/issues-pr/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/pulls) Minimalist status line generator for [i3](https://i3wm.org/) / [sway](https://swaywm.org/) bar written in [Go](https://go.dev/) and configred @@ -32,10 +21,14 @@ in [Yaml](https://yaml.org/). In short, this is what [i3blocks](https://github.com/vivien/i3blocks) would look like if I had written it. +This is also where the name comes from - a combination from `i3blocks` and `go`. + +**Note:** this project was formely known as `kherson`, which however could be +considered cultural appropriation, so I decided to rename it. ## Installation and configuration -Refer to the according pages on the [project website](https://alexcoder04.github.io/kherson/). +Refer to the according pages on the [project website](https://alexcoder04.github.io/i3gocks/). ## Contributing @@ -43,6 +36,6 @@ I'm generally open for any kind of contributions, however I have a pretty specific view on the design of this project, so fancy complex features probably would not be accepted. -When in doubt, just open an [issue](https://github.com/alexcoder04/kherson/issues) +When in doubt, just open an [issue](https://github.com/alexcoder04/i3gocks/issues) and we'll discuss your idea there. diff --git a/config.go b/config.go index be6f274..1e2f1ee 100644 --- a/config.go +++ b/config.go @@ -97,13 +97,13 @@ func LoadConfig() Config { if err != nil { return DefaultConfig("cannot get config dir") } - configFile = path.Join(configDir, "kherson", "config.yml") + configFile = path.Join(configDir, "i3gocks", "config.yml") } _, err := os.Stat(configFile) if err != nil { if os.IsNotExist(err) { - return DefaultConfig("kherson (default config)") + return DefaultConfig("i3gocks (default config)") } return DefaultConfig("cannot stat config") } diff --git a/docs/Configuration.md b/docs/Configuration.md index d2dadca..aa4536d 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -3,7 +3,7 @@ Configuration is done in [yaml](https://yaml.org/), a human- and machine-friendly markup language. -The config file is located at `$XDG_CONFIG_HOME/kherson/config.yml` +The config file is located at `$XDG_CONFIG_HOME/i3gocks/config.yml` If the config does not exist or cannot be loaded, the minimal default hardcoded config is used. @@ -28,9 +28,9 @@ Options: PowerlineSeparator: "\uE0BE" ``` -If `PowerlineTheme` is set to true, kherson will draw a custom separator between +If `PowerlineTheme` is set to true, i3gocks will draw a custom separator between the blocks. This separator is defined in `PowerlineSeparator` and is supposed to -be a Nerd Font / Powerline glyph (kherson will set its foreground color to +be a Nerd Font / Powerline glyph (i3gocks will set its foreground color to module's background color, and the background to previous module's background). # Modules @@ -52,7 +52,7 @@ module's background color, and the background to previous module's background). ## Name -Key that is used by i3bar/swaybar and kherson to identify the blocks. +Key that is used by i3bar/swaybar and i3gocks to identify the blocks. Possible values: any string @@ -119,7 +119,7 @@ Possible values: `none` / `pango` ## Signal -Number of signal (`SIGRTMIN+n`) that can be sent to kherson to reload the block. +Number of signal (`SIGRTMIN+n`) that can be sent to i3gocks to reload the block. Possible values: `1`-`15` diff --git a/docs/Installation.md b/docs/Installation.md index 9309b2f..e4df683 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,17 +1,17 @@ # Arch Linux -kherson is available on the [AUR](https://aur.archlinux.org/packages/kherson). +i3gocks is available on the [AUR](https://aur.archlinux.org/packages/i3gocks). # Prebuild release (all distros, binary only) -Download the binary from [github.com/alexcoder04/kherson/releases/latest](https://github.com/alexcoder04/kherson/releases/latest) and copy it to a directory in your `$PATH`. +Download the binary from [github.com/alexcoder04/i3gocks/releases/latest](https://github.com/alexcoder04/i3gocks/releases/latest) and copy it to a directory in your `$PATH`. # Other Distros (Make) ```sh -git clone "https://github.com/alexcoder04/kherson.git" -cd kherson +git clone "https://github.com/alexcoder04/i3gocks.git" +cd i3gocks make sudo make install ``` diff --git a/docs/Setting-Up.md b/docs/Setting-Up.md index baf2aba..192388f 100644 --- a/docs/Setting-Up.md +++ b/docs/Setting-Up.md @@ -1,14 +1,14 @@ -# Enable kherson +# Enable i3gocks Add following line to your i3/sway config: ```conf bar { - status_command kherson + status_command i3gocks } ``` -and create a config file at `$XDG_CONFIG_HOME/kherson/config.yml`. +and create a config file at `$XDG_CONFIG_HOME/i3gocks/config.yml`. More info about the configuration can be found [here](./Configuration.html). diff --git a/docs/index.md b/docs/index.md index a0fcafd..0112df1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,12 @@ -### kherson is a minimal status line generator for [i3](https://i3wm.org)bar / [sway](https://swaywm.org)bar written in [Go](https://go.dev) and configured in [YAML](https://yaml.org). +### i3gocks is a minimal status line generator for [i3](https://i3wm.org)bar / [sway](https://swaywm.org)bar written in [Go](https://go.dev) and configured in [YAML](https://yaml.org). -screenshot 1 -screenshot 2 -screenshot 3 -screenshot 4 -screenshot 5 -screenshot 6 +screenshot 1 +screenshot 2 +screenshot 3 +screenshot 4 +screenshot 5 +screenshot 6 ### Here you can find the documentation: @@ -18,5 +18,5 @@ ## Misc -To reload the config while running, signal `SIGUSR1` to kherson. +To reload the config while running, signal `SIGUSR1` to i3gocks. diff --git a/go.mod b/go.mod index 14158df..c38259b 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/alexcoder04/kherson +module github.com/alexcoder04/i3gocks go 1.18 diff --git a/kherson.1 b/i3gocks.1 similarity index 51% rename from kherson.1 rename to i3gocks.1 index 511509f..8545738 100644 --- a/kherson.1 +++ b/i3gocks.1 @@ -1,25 +1,25 @@ -.TH "kherson" "1" +.TH "i3gocks" "1" .SH "NAME" .PP -kherson - Minimal status line generator for i3/sway +i3gocks - Minimal status line generator for i3/sway .SH "SYNOPSIS" .PP -kherson [-config] +i3gocks [-config] .SH "OPTIONS" .SS "-config path" .PP -Specify path to config. (default: "$XDG_CONFIG_HOME/kherson/config.yml") +Specify path to config. (default: "$XDG_CONFIG_HOME/i3gocks/config.yml") .SH "DESCRIPTION" .PP -kherson is a minimal status line generator for i3bar/swaybar written in Go and configured in YAML. +i3gocks is a minimal status line generator for i3bar/swaybar written in Go and configured in YAML. .SH "CONFIGURATION" .PP -For more info about the configuration please refer to the project website (\fIhttps://alexcoder04.github.io/kherson/\fP) +For more info about the configuration please refer to the project website (\fIhttps://alexcoder04.github.io/i3gocks/\fP) .SH "AUTHOR" .PP diff --git a/screenshots/screenshot-kherson-default.png b/screenshots/screenshot-i3gocks-default.png similarity index 100% rename from screenshots/screenshot-kherson-default.png rename to screenshots/screenshot-i3gocks-default.png diff --git a/screenshots/screenshot-kherson-dracula-blocks.png b/screenshots/screenshot-i3gocks-dracula-blocks.png similarity index 100% rename from screenshots/screenshot-kherson-dracula-blocks.png rename to screenshots/screenshot-i3gocks-dracula-blocks.png diff --git a/screenshots/screenshot-kherson-dracula-my.png b/screenshots/screenshot-i3gocks-dracula-my.png similarity index 100% rename from screenshots/screenshot-kherson-dracula-my.png rename to screenshots/screenshot-i3gocks-dracula-my.png diff --git a/screenshots/screenshot-kherson-macwal-my.png b/screenshots/screenshot-i3gocks-macwal-my.png similarity index 100% rename from screenshots/screenshot-kherson-macwal-my.png rename to screenshots/screenshot-i3gocks-macwal-my.png diff --git a/screenshots/screenshot-kherson-my.png b/screenshots/screenshot-i3gocks-my.png similarity index 100% rename from screenshots/screenshot-kherson-my.png rename to screenshots/screenshot-i3gocks-my.png diff --git a/screenshots/screenshot-kherson-powerline-oceanic-next.png b/screenshots/screenshot-i3gocks-powerline-oceanic-next.png similarity index 100% rename from screenshots/screenshot-kherson-powerline-oceanic-next.png rename to screenshots/screenshot-i3gocks-powerline-oceanic-next.png