diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..a864bb9 --- /dev/null +++ b/Readme.md @@ -0,0 +1,38 @@ +# Setup + +`ncmprs` requires a `config.toml` file that points to your FLAC music library. + +## Linux + +1. Create the configuration directory: + ```sh + mkdir -p "$XDG_CONFIG_HOME/ncmprs" + ``` + +2. Create the configuration file: + ```sh + touch "$XDG_CONFIG_HOME/ncmprs/config.toml" + ``` + +3. Add the path to your music library: + ```toml + library_path = "/path/to/your/music" + ``` + +--- + +## Windows + +1. Create the configuration directory: + ``` + C:\Users\\AppData\Roaming\ncmprs\ + ``` + +2. Create a file named `config.toml` inside that directory. + +3. Add the path to your music library: + ```toml + library_path = "Z:\\Users\\\\Music" + ``` + +> **Note:** Windows paths in TOML require backslashes to be escaped (`\\` instead of `\`).