Skip to content

Commit 53ded83

Browse files
alexcoder04alexcoder04
committed
rename project
1 parent cd5312f commit 53ded83

16 files changed

+52
-59
lines changed

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*.dll
55
*.so
66
*.dylib
7-
kherson
7+
i3gocks
88

99
# Test binary, built with `go test -c`
1010
*.test

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
SHELL = /bin/sh
33
PREFIX ?= /usr
4-
NAME = kherson
4+
NAME = i3gocks
55

66
build:
77
GOOS=linux GOARCH=amd64 go build -o $(NAME) .

‎README.md‎

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,41 @@
11

2-
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)
3-
4-
On 24 February 2022 Russia invaded Ukraine and is killing thousands of innocent
5-
civilians. This has to stop! I named my new project after
6-
[Kherson](https://en.wikipedia.org/wiki/Kherson), a city in the south of
7-
Ukraine, to draw attention to this inacceptable issue.
8-
9-
*Update 11.11.2022:* Kherson is Ukrainian ~~again~~ as it always was.
10-
11-
---
12-
13-
# kherson
14-
15-
<img style="width: 100%;" alt="screenshot 1" src="screenshots/screenshot-kherson-default.png">
16-
<img style="width: 100%;" alt="screenshot 2" src="screenshots/screenshot-kherson-dracula-blocks.png">
17-
<img style="width: 100%;" alt="screenshot 3" src="screenshots/screenshot-kherson-dracula-my.png">
18-
<img style="width: 100%;" alt="screenshot 4" src="screenshots/screenshot-kherson-powerline-oceanic-next.png">
19-
<img style="width: 100%;" alt="screenshot 5" src="screenshots/screenshot-kherson-my.png">
20-
<img style="width: 100%;" alt="screenshot 6" src="screenshots/screenshot-kherson-macwal-my.png">
21-
22-
[![Release](https://img.shields.io/github/v/release/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/releases/latest)
23-
[![AUR](https://img.shields.io/aur/version/kherson)](https://aur.archlinux.org/packages/kherson)
24-
[![Top language](https://img.shields.io/github/languages/top/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/search?l=go)
25-
[![License](https://img.shields.io/github/license/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/blob/main/LICENSE)
26-
[![Issues](https://img.shields.io/github/issues/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/issues)
27-
[![Pull requests](https://img.shields.io/github/issues-pr/alexcoder04/kherson)](https://github.com/alexcoder04/kherson/pulls)
2+
# i3gocks
3+
4+
<img style="width: 100%;" alt="screenshot 1" src="screenshots/screenshot-i3gocks-default.png">
5+
<img style="width: 100%;" alt="screenshot 2" src="screenshots/screenshot-i3gocks-dracula-blocks.png">
6+
<img style="width: 100%;" alt="screenshot 3" src="screenshots/screenshot-i3gocks-dracula-my.png">
7+
<img style="width: 100%;" alt="screenshot 4" src="screenshots/screenshot-i3gocks-powerline-oceanic-next.png">
8+
<img style="width: 100%;" alt="screenshot 5" src="screenshots/screenshot-i3gocks-my.png">
9+
<img style="width: 100%;" alt="screenshot 6" src="screenshots/screenshot-i3gocks-macwal-my.png">
10+
11+
[![Release](https://img.shields.io/github/v/release/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/releases/latest)
12+
[![AUR](https://img.shields.io/aur/version/i3gocks)](https://aur.archlinux.org/packages/i3gocks)
13+
[![Top language](https://img.shields.io/github/languages/top/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/search?l=go)
14+
[![License](https://img.shields.io/github/license/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/blob/main/LICENSE)
15+
[![Issues](https://img.shields.io/github/issues/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/issues)
16+
[![Pull requests](https://img.shields.io/github/issues-pr/alexcoder04/i3gocks)](https://github.com/alexcoder04/i3gocks/pulls)
2817

2918
Minimalist status line generator for [i3](https://i3wm.org/) /
3019
[sway](https://swaywm.org/) bar written in [Go](https://go.dev/) and configred
3120
in [Yaml](https://yaml.org/).
3221

3322
In short, this is what [i3blocks](https://github.com/vivien/i3blocks) would
3423
look like if I had written it.
24+
This is also where the name comes from - a combination from `i3blocks` and `go`.
25+
26+
**Note:** this project was formely known as `kherson`, which however could be
27+
considered cultural appropriation, so I decided to rename it.
3528

3629
## Installation and configuration
3730

38-
Refer to the according pages on the [project website](https://alexcoder04.github.io/kherson/).
31+
Refer to the according pages on the [project website](https://alexcoder04.github.io/i3gocks/).
3932

4033
## Contributing
4134

4235
I'm generally open for any kind of contributions, however I have a pretty
4336
specific view on the design of this project, so fancy complex features probably
4437
would not be accepted.
4538

46-
When in doubt, just open an [issue](https://github.com/alexcoder04/kherson/issues)
39+
When in doubt, just open an [issue](https://github.com/alexcoder04/i3gocks/issues)
4740
and we'll discuss your idea there.
4841

‎config.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ func LoadConfig() Config {
9797
if err != nil {
9898
return DefaultConfig("cannot get config dir")
9999
}
100-
configFile = path.Join(configDir, "kherson", "config.yml")
100+
configFile = path.Join(configDir, "i3gocks", "config.yml")
101101
}
102102

103103
_, err := os.Stat(configFile)
104104
if err != nil {
105105
if os.IsNotExist(err) {
106-
return DefaultConfig("kherson (default config)")
106+
return DefaultConfig("i3gocks (default config)")
107107
}
108108
return DefaultConfig("cannot stat config")
109109
}

‎docs/Configuration.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Configuration is done in [yaml](https://yaml.org/), a human- and machine-friendly markup language.
55

6-
The config file is located at `$XDG_CONFIG_HOME/kherson/config.yml`
6+
The config file is located at `$XDG_CONFIG_HOME/i3gocks/config.yml`
77

88
If the config does not exist or cannot be loaded, the minimal default hardcoded config is used.
99

@@ -28,9 +28,9 @@ Options:
2828
PowerlineSeparator: "\uE0BE"
2929
```
3030
31-
If `PowerlineTheme` is set to true, kherson will draw a custom separator between
31+
If `PowerlineTheme` is set to true, i3gocks will draw a custom separator between
3232
the blocks. This separator is defined in `PowerlineSeparator` and is supposed to
33-
be a Nerd Font / Powerline glyph (kherson will set its foreground color to
33+
be a Nerd Font / Powerline glyph (i3gocks will set its foreground color to
3434
module's background color, and the background to previous module's background).
3535

3636
# Modules
@@ -52,7 +52,7 @@ module's background color, and the background to previous module's background).
5252

5353
## Name
5454

55-
Key that is used by i3bar/swaybar and kherson to identify the blocks.
55+
Key that is used by i3bar/swaybar and i3gocks to identify the blocks.
5656

5757
Possible values: any string
5858

@@ -119,7 +119,7 @@ Possible values: `none` / `pango`
119119

120120
## Signal
121121

122-
Number of signal (`SIGRTMIN+n`) that can be sent to kherson to reload the block.
122+
Number of signal (`SIGRTMIN+n`) that can be sent to i3gocks to reload the block.
123123

124124
Possible values: `1`-`15`
125125

‎docs/Installation.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11

22
# Arch Linux
33

4-
kherson is available on the [AUR](https://aur.archlinux.org/packages/kherson).
4+
i3gocks is available on the [AUR](https://aur.archlinux.org/packages/i3gocks).
55

66
# Prebuild release (all distros, binary only)
77

8-
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`.
8+
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`.
99

1010
# Other Distros (Make)
1111

1212
```sh
13-
git clone "https://github.com/alexcoder04/kherson.git"
14-
cd kherson
13+
git clone "https://github.com/alexcoder04/i3gocks.git"
14+
cd i3gocks
1515
make
1616
sudo make install
1717
```

‎docs/Setting-Up.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11

2-
# Enable kherson
2+
# Enable i3gocks
33

44
Add following line to your i3/sway config:
55

66
```conf
77
bar {
8-
status_command kherson
8+
status_command i3gocks
99
}
1010
```
1111

12-
and create a config file at `$XDG_CONFIG_HOME/kherson/config.yml`.
12+
and create a config file at `$XDG_CONFIG_HOME/i3gocks/config.yml`.
1313
More info about the configuration can be found [here](./Configuration.html).
1414

‎docs/index.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11

2-
### 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).
2+
### 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).
33

4-
<img style="width: 100%;" alt="screenshot 1" src="https://raw.githubusercontent.com/alexcoder04/kherson/main/screenshots/screenshot-kherson-default.png">
5-
<img style="width: 100%;" alt="screenshot 2" src="https://raw.githubusercontent.com/alexcoder04/kherson/main/screenshots/screenshot-kherson-dracula-blocks.png">
6-
<img style="width: 100%;" alt="screenshot 3" src="https://raw.githubusercontent.com/alexcoder04/kherson/main/screenshots/screenshot-kherson-dracula-my.png">
7-
<img style="width: 100%;" alt="screenshot 4" src="https://raw.githubusercontent.com/alexcoder04/kherson/main/screenshots/screenshot-kherson-powerline-oceanic-next.png">
8-
<img style="width: 100%;" alt="screenshot 5" src="https://raw.githubusercontent.com/alexcoder04/kherson/main/screenshots/screenshot-kherson-my.png">
9-
<img style="width: 100%;" alt="screenshot 6" src="https://raw.githubusercontent.com/alexcoder04/kherson/main/screenshots/screenshot-kherson-macwal-my.png">
4+
<img style="width: 100%;" alt="screenshot 1" src="https://raw.githubusercontent.com/alexcoder04/i3gocks/main/screenshots/screenshot-i3gocks-default.png">
5+
<img style="width: 100%;" alt="screenshot 2" src="https://raw.githubusercontent.com/alexcoder04/i3gocks/main/screenshots/screenshot-i3gocks-dracula-blocks.png">
6+
<img style="width: 100%;" alt="screenshot 3" src="https://raw.githubusercontent.com/alexcoder04/i3gocks/main/screenshots/screenshot-i3gocks-dracula-my.png">
7+
<img style="width: 100%;" alt="screenshot 4" src="https://raw.githubusercontent.com/alexcoder04/i3gocks/main/screenshots/screenshot-i3gocks-powerline-oceanic-next.png">
8+
<img style="width: 100%;" alt="screenshot 5" src="https://raw.githubusercontent.com/alexcoder04/i3gocks/main/screenshots/screenshot-i3gocks-my.png">
9+
<img style="width: 100%;" alt="screenshot 6" src="https://raw.githubusercontent.com/alexcoder04/i3gocks/main/screenshots/screenshot-i3gocks-macwal-my.png">
1010

1111
### Here you can find the documentation:
1212

@@ -18,5 +18,5 @@
1818

1919
## Misc
2020

21-
To reload the config while running, signal `SIGUSR1` to kherson.
21+
To reload the config while running, signal `SIGUSR1` to i3gocks.
2222

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/alexcoder04/kherson
1+
module github.com/alexcoder04/i3gocks
22

33
go 1.18
44

‎kherson.1‎ renamed to ‎i3gocks.1‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
.TH "kherson" "1"
1+
.TH "i3gocks" "1"
22

33
.SH "NAME"
44
.PP
5-
kherson - Minimal status line generator for i3/sway
5+
i3gocks - Minimal status line generator for i3/sway
66

77
.SH "SYNOPSIS"
88
.PP
9-
kherson [-config]
9+
i3gocks [-config]
1010

1111
.SH "OPTIONS"
1212
.SS "-config path"
1313
.PP
14-
Specify path to config. (default: "$XDG_CONFIG_HOME/kherson/config.yml")
14+
Specify path to config. (default: "$XDG_CONFIG_HOME/i3gocks/config.yml")
1515

1616
.SH "DESCRIPTION"
1717
.PP
18-
kherson is a minimal status line generator for i3bar/swaybar written in Go and configured in YAML.
18+
i3gocks is a minimal status line generator for i3bar/swaybar written in Go and configured in YAML.
1919

2020
.SH "CONFIGURATION"
2121
.PP
22-
For more info about the configuration please refer to the project website (\fIhttps://alexcoder04.github.io/kherson/\fP)
22+
For more info about the configuration please refer to the project website (\fIhttps://alexcoder04.github.io/i3gocks/\fP)
2323

2424
.SH "AUTHOR"
2525
.PP

0 commit comments

Comments
 (0)