Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
rsmeowry committed Sep 9, 2023
1 parent 3a19f75 commit 7c849db
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,45 @@ After that, you can run verses.
* `k` | `up key` - scroll up
* `r` - reset scroll position

## Config

Config file is located at `$HOME/.config/verses/config.toml`

Each TOML section can be included in a separate file, just specify it using the `include` field.

For example:

```toml
# config.toml

[theme]
include = "themes/catppuccin.toml"

# themes/catppuccin.toml
[borders]
# configuration there...

[lyrics]
# ...

[progress_bar]
# ...
```

Config has certain special value types:

### general.display.*_format

These are formatting strings using the Handlebars syntax, specifically [the Rust implementation](https://github.com/sunng87/handlebars-rust).
Available variables are listend in the example config. There is also an utility function `join` that allows to join a list of strings separated by a comma.

### Colors

Colors can either be represented the [Ratatui stringified way](https://docs.rs/ratatui/latest/ratatui/style/enum.Color.html) or as a hex RGB value, prefixed with `#`

### Border styles

These are enum variants. You can see [all variants here](https://docs.rs/ratatui/latest/ratatui/widgets/block/enum.BorderType.html)

## Windows support
Windows was not tested at all, and while it should run well, I do not guarantee flawless performance

0 comments on commit 7c849db

Please sign in to comment.