diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 3 insertions, 1 deletions
| @@ -11,10 +11,12 @@ $ git clone https://git.sixfoisneuf.fr/termsonic && cd termsonic | |||
| 11 | $ go build -o termsonic ./cmd | 11 | $ go build -o termsonic ./cmd |
| 12 | ``` | 12 | ``` |
| 13 | 13 | ||
| 14 | Please note that Linux builds additionally need a working C compiler in their PATH. This is due to [faiface/beep](https://github.com/faiface/beep), used for audio playback. | ||
| 15 | |||
| 14 | ## Configuration | 16 | ## Configuration |
| 15 | 17 | ||
| 16 | The application reads its configuration from `$XDG_CONFIG_DIR/termsonic.toml`, or `~/.config/termsonic.toml` if `XDG_CONFIG_DIR` doesn't exist. | 18 | The application reads its configuration from `$XDG_CONFIG_DIR/termsonic.toml`, or `~/.config/termsonic.toml` if `XDG_CONFIG_DIR` doesn't exist. |
| 17 | 19 | ||
| 18 | On Windows, it reads its configuration from `%APPDATA%\\Termsonic\\termsonic.toml`. | 20 | On Windows, it reads its configuration from `%APPDATA%\\Termsonic\\termsonic.toml`. |
| 19 | 21 | ||
| 20 | You can edit the configuration from inside the app, or by passing parameters on the command line (see `--help`). \ No newline at end of file | 22 | You can edit the configuration from inside the app, or by hand using a text editor. See [the example configuration file](config.toml.example), and [the TOML reference](https://toml.io/en/). It is possible to specify another configuration file with the `-config` command-line argument. \ No newline at end of file |