Skip to content

Commit

Permalink
rename project
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcoder04 committed Feb 17, 2023
1 parent cd5312f commit 53ded83
Show file tree
Hide file tree
Showing 16 changed files with 52 additions and 59 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*.dll
*.so
*.dylib
kherson
i3gocks

# Test binary, built with `go test -c`
*.test
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

SHELL = /bin/sh
PREFIX ?= /usr
NAME = kherson
NAME = i3gocks

build:
GOOS=linux GOARCH=amd64 go build -o $(NAME) .
Expand Down
49 changes: 21 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,41 @@

[![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

<img style="width: 100%;" alt="screenshot 1" src="screenshots/screenshot-kherson-default.png">
<img style="width: 100%;" alt="screenshot 2" src="screenshots/screenshot-kherson-dracula-blocks.png">
<img style="width: 100%;" alt="screenshot 3" src="screenshots/screenshot-kherson-dracula-my.png">
<img style="width: 100%;" alt="screenshot 4" src="screenshots/screenshot-kherson-powerline-oceanic-next.png">
<img style="width: 100%;" alt="screenshot 5" src="screenshots/screenshot-kherson-my.png">
<img style="width: 100%;" alt="screenshot 6" src="screenshots/screenshot-kherson-macwal-my.png">

[![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

<img style="width: 100%;" alt="screenshot 1" src="screenshots/screenshot-i3gocks-default.png">
<img style="width: 100%;" alt="screenshot 2" src="screenshots/screenshot-i3gocks-dracula-blocks.png">
<img style="width: 100%;" alt="screenshot 3" src="screenshots/screenshot-i3gocks-dracula-my.png">
<img style="width: 100%;" alt="screenshot 4" src="screenshots/screenshot-i3gocks-powerline-oceanic-next.png">
<img style="width: 100%;" alt="screenshot 5" src="screenshots/screenshot-i3gocks-my.png">
<img style="width: 100%;" alt="screenshot 6" src="screenshots/screenshot-i3gocks-macwal-my.png">

[![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
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

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.

4 changes: 2 additions & 2 deletions config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
}
Expand Down
10 changes: 5 additions & 5 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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`

Expand Down
8 changes: 4 additions & 4 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
6 changes: 3 additions & 3 deletions docs/Setting-Up.md
Original file line number Diff line number Diff line change
@@ -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).

16 changes: 8 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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).

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

### Here you can find the documentation:

Expand All @@ -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.

2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/alexcoder04/kherson
module github.com/alexcoder04/i3gocks

go 1.18

Expand Down
12 changes: 6 additions & 6 deletions kherson.1 → i3gocks.1
Original file line number Diff line number Diff line change
@@ -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
Expand Down
File renamed without changes
File renamed without changes

0 comments on commit 53ded83

Please sign in to comment.