add instructions to readme
This commit is contained in:
@@ -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\<YourUser>\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\\<YourUser>\\Music"
|
||||
```
|
||||
|
||||
> **Note:** Windows paths in TOML require backslashes to be escaped (`\\` instead of `\`).
|
||||
Reference in New Issue
Block a user