Merge pull request #1067 from eladyn/docs_improvements

improvements to the documentation

docs/src/SUMMARY.md

@@ -7,11 +7,11 @@
   - [Installing on Ubuntu (from source)](./installation/Ubuntu.md)
   - [Cross Compiling on Ubuntu](./installation/Cross-Compiling-on-Ubuntu.md)
   - [Installing with Homebrew on macOS](./installation/MacOS.md)
-  - [Feature Flags](./Feature-flags.md)
+  - [Installing on FreeBSD](./installation/FreeBSD.md)
 - [Configuration](./config/README.md)
   - [CLI options](./config/Cli.md)
   - [Configuration file](./config/File.md)
-  - [Running as a Service]()
-    - [Running as systemd service](./config/services/Sytemd.md)
+  - [Running as a Service](./config/services/README.md)
+    - [Running as systemd service](./config/services/Systemd.md)
     - [Running as launchd service (MacOS)](./config/services/MacOS.md)
 

docs/src/config/services/README.md

@@ -0,0 +1,3 @@
+# Running as a Service
+
+You can run Spotifyd as a service that automatically starts in the background.

docs/src/installation/FreeBSD.md

@@ -14,24 +14,11 @@ This guide will help you to install `spotifyd` on FreeBSD and have it always run
 sudo pkg install spotifyd
 ```
 
-## Config file
-
-
-Input the following data. Change the **username**, **password**, **device_name**, and the **bitrate**.
-
-```toml
-[global]
-username = "USER"
-password = "PASS"
-backend = "portaudio"
-device = "/dev/dsp"
-#onevent = command_run_on_playback_event
-device_name = "name_in_spotify_connect"
-bitrate = 96|160|320
-cache_path = "cache_directory"
-volume-normalisation = true
-normalisation-pregain = -10
-```
+## Configuring spotifyd
+
+If you installed spotifyd using the above method, you'll either need to supply `--backend portaudio` as a command-line argument or add `backend = "portaudio"` to `/usr/local/etc/spotifyd.conf`.
+
+Apart from that, spotifyd comes pre-configured with defaults that should be working in most cases, but if you want to tweak it further to your needs, have a look at the [configuration section](../config/) of this book.
 
 ## Start the service
 
@@ -45,4 +32,4 @@ Now see if you can find it in the normal Spotify client (Devices in right bottom
 
 ```sh
 sudo sysrc spotifyd_enable=YES
-```
+```

docs/src/installation/Raspberry-Pi.md

@@ -10,7 +10,7 @@ You will now see a file called `spotifyd`. You can run it with `./spotifyd --no-
 
 ## Systemd daemon file
 
-Create a systemd service file and copy the config from https://github.com/Spotifyd/spotifyd/blob/master/contrib/spotifyd.service into it. Change **ExecStart** to where you unzipped the `spotifyd` binary.
+Create a systemd service file and copy the [default configuration](https://github.com/Spotifyd/spotifyd/blob/master/contrib/spotifyd.service) into it. Change **ExecStart** to where you unzipped the `spotifyd` binary.
 
 ```bash
 sudo nano /etc/systemd/user/spotifyd.service
@@ -24,32 +24,9 @@ nano ~/.config/systemd/user/spotifyd.service
 systemctl --user daemon-reload
 ```
 
-## Config file
+## Configuring spotifyd
 
-Create your config:
-
-```bash
-mkdir ~/.config/spotifyd/
-nano ~/.config/spotifyd/spotifyd.conf
-```
-
-Input the following data. Change the **username**, **password**, **device_name**, and the **bitrate**.
-
-```toml
-[global]
-username = "USER"
-password = "PASS"
-backend = "alsa"
-device = alsa_audio_device # Given by `aplay -L`
-mixer = "PCM"
-volume-controller = "alsa" # or alsa_linear, or softvol
-#onevent = command_run_on_playback_event
-device_name = "name_in_spotify_connect"
-bitrate = 96|160|320
-cache_path = "cache_directory"
-volume-normalisation = true
-normalisation-pregain = -10
-```
+Spotifyd comes pre-configured with defaults that should be working in most cases, but if you want to tweak it further to your needs, have a look at the [configuration section](../config/) of this book.
 
 ## Start the service