Improved README
authorkaliko <kaliko@azylum.org>
Sun, 25 Oct 2015 20:37:27 +0000 (21:37 +0100)
committerkaliko <kaliko@azylum.org>
Sun, 25 Oct 2015 20:37:27 +0000 (21:37 +0100)
README.rst

index fc5e808..27e1c8c 100644 (file)
@@ -3,50 +3,62 @@ Description
 
 This image contains MPD, icecast2 and MPD_sima in order to serve an audio stream over http.
 
-MPD is looking for music in /music (``music_directory`` option) and keeps its
-dataset in /var/lib/mpd (options: ``playlist_directory``, ``{db,sticker,state}_file``).
+MPD is looking for music in */music* (``music_directory`` option) and keeps its
+dataset in */var/lib/mpd* (options: ``playlist_directory``, ``{db,sticker,state}_file``).
 
-TL;DR
+tl;dr
 =====
 
-Build an image and run a container out of it.
-Then point you MPD client to the run container::
+Build an image and run a container out of it::
 
     ./do build  # optional but then it'll fetch an image from hub.docker.com
     MUSIC=/pat/to/my/music/library ./do run
 
+Then point your MPD client to ``localhost:6601``.
+
 Configuration
 =============
 
 Running a container to play to content of your music library:
 
-  - Audio stream available from http://127.0.0.1:8001
-  - MPD available on 127.0.0.1:6601
-  - Music directory: /path/to/my/music/library
+::
 
-Commands::
     LISTEN=127.0.0.1
     MUSIC="/path/to/my/music/library"
     OPTIONS="-p ${LISTEN}:8001:8000"
     OPTIONS="${OPTIONS} -p ${LISTEN}:6601:6600"
     OPTIONS="${OPTIONS} --volume ${MUSIC}:/music:ro"
-    docker run ${OPTIONS} --detach=true --name sima kaliko/sima
+    docker run ${OPTIONS} --name sima kaliko/sima
+
+The container ``sima`` is running with the following configuration:
+
+  - Music directory: /path/to/my/music/library
+  - Audio stream available from http://127.0.0.1:8001
+  - MPD available on 127.0.0.1:6601
+
 
 To run mpd-sima with a specific configuration mount the file in the running container.
-When /etc/mpd-sima.cfg is present in the container the default is to read it::
+When /etc/mpd-sima.cfg is present in the container the default is to read it.
+
+::
 
     OPTIONS="-P --detach=true"
     docker run -v ./my.config:/etc/mpd-sima.cfg ${OPTIONS} --name sima kaliko/sima
     # Discover ports with "docker port sima"
 
-Mounting your music directory and saving MPD database in ${PWD}/data::
+Mounting your music directory and saving MPD database in ${PWD}/data:
+
+::
 
     OPTIONS="-P --detach=true"
-    docker run -v ~/Music:/music:ro -v ${PWD}/data:/var/lib/mpd ${OPTIONS} --name sima kaliko/sima
+    OPTIONS="${OPTIONS} -v ~/Music:/music:ro -v ${PWD}/data:/var/lib/mpd"
+    docker run ${OPTIONS} --name sima kaliko/sima
     # Discover ports with "docker port sima"
 
 Default option to run mpd-sima is "--log /var/log/mpd/mpd-sima.log".
-Environment variable MPD_SIMA might be used to override default command line options::
+Environment variable MPD_SIMA might be used to override default command line options:
+
+::
 
     OPTIONS="-P --detach=true"
     docker run --env="MPD_SIMA=--log-level debug --log /var/log/mpd/mpd-sima.log" -v ${PWD}/log:/var/log/mpd ${OPTIONS} --name sima kaliko/sima