Skip to content

Commit

Permalink
Add new theme photos, make md links relative
Browse files Browse the repository at this point in the history
  • Loading branch information
bim9262 committed Jul 28, 2023
1 parent 0c275b7 commit fcf10d7
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 23 deletions.
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@

### Packaging

Manual page is no longer provided in the repo. To generate `man/i3status-rs.1` run `cargo xtask generate-manpage`. See [manual_install.md](https://github.com/greshake/i3status-rust/blob/master/doc/manual_install.md) for more details.
Manual page is no longer provided in the repo. To generate `man/i3status-rs.1` run `cargo xtask generate-manpage`. See [manual_install.md](doc/manual_install.md) for more details.

# i3status-rust 0.30.4

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# i3status-rust

![demo1](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/solarized-dark.png)
![demo1](img/themes/solarized-dark.png)

`i3status-rs` is a feature-rich and resource-friendly replacement for i3status, written in pure Rust. It provides a way to display "blocks" of system information (time, battery status, volume, etc) on bars that support the [i3bar protocol](https://i3wm.org/docs/i3bar-protocol.html).

Expand All @@ -16,25 +16,25 @@ Install from one of the packages below:

* **NOTE:** Installation via `cargo` is not supported.

Otherwise refer to [manual install](https://github.com/greshake/i3status-rust/blob/master/doc/manual_install.md) docs.
Otherwise refer to [manual install](doc/manual_install.md) docs.

## Configuration

After installing `i3status-rust`, edit the [example configuration](https://raw.githubusercontent.com/greshake/i3status-rust/master/examples/config.toml) to your liking.
After installing `i3status-rust`, edit the [example configuration](examples/config.toml) to your liking.
The default location is `$XDG_CONFIG_HOME/i3status-rust/config.toml`.

There are some optional global configuration variables, defined either at the top-level or in a [TOML table](https://github.com/toml-lang/toml/blob/main/toml.md#table).

`[icons]` table:
Key | Description | Default
----|-------------|----------
`icons` | The [icon set](https://github.com/greshake/i3status-rust/blob/master/doc/themes.md#available-icon-sets) that should be used. | `"none"`
`icons` | The [icon set](doc/themes.md#available-icon-sets) that should be used. | `"none"`
`[icons.icons_overrides]` | Refer to `Themes and Icons` below. | None

`[theme]` table:
Key | Description | Default
----|-------------|----------
`theme` | The [theme](https://github.com/greshake/i3status-rust/blob/master/doc/themes.md#available-themes) that should be used. | `"plain"`
`theme` | The [theme](doc/themes.md#available-themes) that should be used. | `"plain"`
`[theme.theme_overrides]` | Refer to `Themes and Icons` below. | None

Global variables:
Expand Down Expand Up @@ -64,7 +64,7 @@ short_error_message | The short error message, if available

- [Blocks](https://greshake.github.io/i3status-rust/i3status_rs/blocks/index.html)
- [Formatting](https://greshake.github.io/i3status-rust/i3status_rs/formatting/index.html)
- [Themes and Icons](https://github.com/greshake/i3status-rust/blob/master/doc/themes.md)
- [Themes and Icons](doc/themes.md)

## Integrate it into i3/sway

Expand Down
1 change: 1 addition & 0 deletions cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ words:
- kmon
- libc
- liquidctl
- macchiato
- maildir
- mebi
- metno
Expand Down
40 changes: 24 additions & 16 deletions doc/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,36 +27,44 @@ Notes:

# Available themes

Note: screenshots were generated using [this config](https://github.com/greshake/i3status-rust/blob/master/gen-screenshots/screenshot_config.toml) with [this swaybar config](https://github.com/greshake/i3status-rust/blob/master/gen-screenshots/swayconfig_i3rs).
Note: screenshots were generated using [this config](../gen-screenshots/screenshot_config.toml) with [this swaybar config](../gen-screenshots/swayconfig_i3rs).

* `plain` (default)
![plain](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/plain.png)
![plain](../img/themes/plain.png)
* `solarized-dark`
![solarized-dark](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/solarized-dark.png)
![solarized-dark](../img/themes/solarized-dark.png)
* `solarized-light`
![solarized-light](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/solarized-light.png)
![solarized-light](../img/themes/solarized-light.png)
* `slick`
![slick](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/slick.png)
![slick](../img/themes/slick.png)
* `modern`
![modern](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/modern.png)
![modern](../img/themes/modern.png)
* `bad-wolf`
![bad-wolf](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/bad-wolf.png)
![bad-wolf](../img/themes/bad-wolf.png)
* `gruvbox-light`
![gruvbox-light](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/gruvbox-light.png)
![gruvbox-light](../img/themes/gruvbox-light.png)
* `gruvbox-dark`
![gruvbox-dark](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/gruvbox-dark.png)
![gruvbox-dark](../img/themes/gruvbox-dark.png)
* `space-villain`
![space-villain](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/space-villain.png)
![space-villain](../img/themes/space-villain.png)
* `native` (like plain with no background and native separators)
![native](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/native.png)
![native](../img/themes/native.png)
* `semi-native` (like native but with background)
![semi-native](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/semi-native.png)
![semi-native](../img/themes/semi-native.png)
* `nord-dark` (polar night)
![nord-dark](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/nord-dark.png)
![nord-dark](../img/themes/nord-dark.png)
* `dracula`
![dracula](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/dracula.png)
![dracula](../img/themes/dracula.png)
* `srcery`
![srcery](https://raw.githubusercontent.com/greshake/i3status-rust/master/img/themes/srcery.png)
![srcery](../img/themes/srcery.png)
* `ctp-frappe`
![ctp-frappe](../img/themes/ctp-frappe.png)
* `ctp-latte`
![ctp-latte](../img/themes/ctp-latte.png)
* `ctp-macchiato`
![ctp-macchiato](../img/themes/ctp-macchiato.png)
* `ctp-mocha`
![ctp-mocha](../img/themes/ctp-mocha.png)

# Available icon sets

Expand Down Expand Up @@ -144,4 +152,4 @@ These can be directly set to a string containing the desired unicode codepoint(s

You can find the codepoints in the documentation of the icon font you're using.

Refer to individual block's documentation for a list of used icons or [provided icon sets](https://github.com/greshake/i3status-rust/tree/master/files/icons) for a complete list of icons.
Refer to individual block's documentation for a list of used icons or [provided icon sets](../files/icons) for a complete list of icons.
1 change: 1 addition & 0 deletions gen-screenshots/swayconfig_i3rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ bar {
status_padding 0
tray_output none
font pango:DejaVu Sans Mono, Font Awesome 6 Free 10
#font pango:DejaVu Sans Mono for Powerline, Font Awesome 6 Free 10
status_command i3status-rs $I3RS_PWD/screenshot_config.toml

colors {
Expand Down
Binary file added img/themes/ctp-frappe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/themes/ctp-latte.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/themes/ctp-macchiato.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/themes/ctp-mocha.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fcf10d7

Please sign in to comment.