From 226d5e74b0486c8d9122ad03459d0569073dca98 Mon Sep 17 00:00:00 2001
From: Simon Garrelou <simon.garrelou@gmail.com>
Date: Thu, 8 Dec 2022 22:43:08 +0100
Subject: Update README

---
 README.md           | 4 +++-
 config.toml.example | 3 +++
 2 files changed, 6 insertions(+), 1 deletion(-)
 create mode 100644 config.toml.example

diff --git a/README.md b/README.md
index 6372bb6..8ad32e2 100644
--- a/README.md
+++ b/README.md
@@ -11,10 +11,12 @@ $ git clone https://git.sixfoisneuf.fr/termsonic && cd termsonic
 $ go build -o termsonic ./cmd
 ```
 
+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.
+
 ## Configuration
 
 The application reads its configuration from `$XDG_CONFIG_DIR/termsonic.toml`, or `~/.config/termsonic.toml` if `XDG_CONFIG_DIR` doesn't exist.
 
 On Windows, it reads its configuration from `%APPDATA%\\Termsonic\\termsonic.toml`.
 
-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
+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 @@
+BaseURL = "http://susonic.myserver.com"
+Username = "admin"
+Password = "admin"
\ No newline at end of file
-- 
cgit v1.2.3