diff options
author | Simon Garrelou <simon.garrelou@gmail.com> | 2022-12-08 22:43:08 +0100 |
---|---|---|
committer | Simon Garrelou <simon.garrelou@gmail.com> | 2022-12-08 22:43:08 +0100 |
commit | 226d5e74b0486c8d9122ad03459d0569073dca98 (patch) | |
tree | e59747e85cf73a10b5c862e824e7e06dbfd0c3a1 | |
parent | de4387bd08cfb26c497114367fb1749d04782c70 (diff) | |
download | termsonic-226d5e74b0486c8d9122ad03459d0569073dca98.tar.gz termsonic-226d5e74b0486c8d9122ad03459d0569073dca98.zip |
Update README
-rw-r--r-- | README.md | 4 | ||||
-rw-r--r-- | config.toml.example | 3 |
2 files changed, 6 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 |
diff --git a/config.toml.example b/config.toml.example new file mode 100644 index 0000000..11365e5 --- /dev/null +++ b/config.toml.example | |||
@@ -0,0 +1,3 @@ | |||
1 | BaseURL = "http://susonic.myserver.com" | ||
2 | Username = "admin" | ||
3 | Password = "admin" \ No newline at end of file | ||