Documentation updated for 8.0.0

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: ace861f5b66c529903baafb42bb03140
+config: 20098eee0cd3e402ff729e6d244f9a51
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/basics/comparison.rst.txt

@@ -8,22 +8,6 @@ information are complete.
 It should just give you an overview of other tools existing.
 Of cause they are all open source, too.
 
-Introducing other tools
------------------------
-
-   * `Beets <http://beets.io/>`_ 
-   * `CherryMusic <http://www.fomori.org/cherrymusic/index.html>`_
-   * `Ampache <http://ampache.org/index.html>`_
-   * `Sonerezh <https://www.sonerezh.bzh/>`_
-   * `Music Player Daemon <https://musicpd.org/>`_
-   * `Modipy <https://www.mopidy.com/>`_
-
-Some tools use `MusicBrainz <https://musicbrainz.org/>`_.
-This project collects music meta data and provides them to the world.
-In general this is a good idea.
-Sadly the information quality is too bad for my claims.
-So using MusicBrainz is both, a feature and an anti feature.
-
 Metrics
 -------
 
@@ -75,56 +59,92 @@ Metrics
 Comparison
 ----------
 
+Candidates are:
+
+   * `Beets <http://beets.io/>`_ 
+   * `CherryMusic <https://github.com/devsnd/cherrymusic>`_
+   * `Ampache <http://ampache.org/index.html>`_
+   * `Sonerezh <https://www.sonerezh.bzh/>`_
+   * `Music Player Daemon <https://musicpd.org/>`_
+   * `Modipy <https://www.mopidy.com/>`_
+
+Some tools use `MusicBrainz <https://musicbrainz.org/>`_.
+This project collects music meta data and provides them to the world.
+In general this is a good idea.
+Sadly the information quality is too bad for my requirements.
+So using MusicBrainz is both, a feature and an anti feature.
+
+Web UI and Streaming Capabilities
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The most obvious features of MusicDB are the WebUI and the streaming features.
+The following tables compares all tools regarding these features.
+
++------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
+| Metric     | MusicDB     | beets       | CherryMusic | Ampache     | Sonerezh    | Modipy      | mpd         |
++============+=============+=============+=============+=============+=============+=============+=============+
+| Streaming  | Yes         | Yes         | No          | Yes         | No          | Yes         | Yes         |
++------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
+| Web UI     | Yes         | No          | Yes         | Yes         | Yes         | No (1)      | No (2)      |
++------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
+
+* (1): There are extensions to access the server from the `web <https://docs.mopidy.com/en/latest/ext/web/#ext-web>`_. Modipy also supports `MPD Clients <https://docs.mopidy.com/en/latest/clients/mpd/>`_.
+* (2): There exist also `Music Player Daemon Clients <https://www.musicpd.org/clients/>`_
+
+   * `Ampache <http://ampache.org/index.html>`_
+   * `Music Player Daemon <https://musicpd.org/>`_
+   * `Modipy <https://www.mopidy.com/>`_
+
+The `Beets <http://beets.io/>`_ project may not be a replacement for MusicDB, but it might be a very good addition.
+Beets could be a tool that is used to prepare a music collection or an album before importing it into the MusicDB universe.
+
+
+Detailed Look
+^^^^^^^^^^^^^
+
++-------------------+-------------+-------------+-------------+-------------+
+| Metric            | MusicDB     | Ampache     | Modipy      | mpd         |
++===================+=============+=============+=============+=============+
+| Focus             | Presenting  | Remote music| Streaming   | Streaming   |
+|                   | music,      | managing via| server, web | server and  |
+|                   | Music queue | WebUI       | player (1)  | clients (2) |
++-------------------+-------------+-------------+-------------+-------------+
+| Information Source| Filesystem, | Tags,       | Tags        | Tags        |
+|                   | Tags,       | MusicBrainz |             |             |
+|                   | Analysis    |             |             |             |
++-------------------+-------------+-------------+-------------+-------------+
+| External Sources  | FFmpeg      | MusicBrainz |             | None        |
+|                   |             |             |             |             |
++-------------------+-------------+-------------+-------------+-------------+
+| File management   | Yes         |             | None        | None        |
+|                   |             |             |             |             |
++-------------------+-------------+-------------+-------------+-------------+
+| File meta data    | Read        | Read?       | Read        | Read        |
++-------------------+-------------+-------------+-------------+-------------+
+| Artwork managing  | Yes         |             |             | No          |
++-------------------+-------------+-------------+-------------+-------------+
+| Lyrics managing   | Yes         | No          |             | No          |
++-------------------+-------------+-------------+-------------+-------------+
+| Export            | Yes         | No          | No          | No          |
++-------------------+-------------+-------------+-------------+-------------+
+| Playlist          | Queue,      | Playlist,   | Playlist    | Queue,      |
+|                   | Random      | Random      |             | Playlist,   |
+|                   |             |             |             | Random      |
++-------------------+-------------+-------------+-------------+-------------+
+| Multiuser         | No          | Yes         | No          | Yes         |
++-------------------+-------------+-------------+-------------+-------------+
+
+* (1): There are extensions to access the server from the `web <https://docs.mopidy.com/en/latest/ext/web/#ext-web>`_. Modipy also supports `MPD Clients <https://docs.mopidy.com/en/latest/clients/mpd/>`_.
+* (2): There exist also `Music Player Daemon Clients <https://www.musicpd.org/clients/>`_
 
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Metric            | MusicDB     | beets       | CherryMusic | Ampache     | Sonerezh    | Modipy      | mpd         |
-+===================+=============+=============+=============+=============+=============+=============+=============+
-| Focus             | Presenting  | File and    | Web audio   | Remote music| Web audio   | Streaming   | Streaming   |
-|                   | music,      | meta data   | player      | managing via| player      | server, web | server and  |
-|                   | Music queue | management  |             | WebUI       |             | player (1)  | clients (2) |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Information Source| Filesystem, | Tags,       | Tags        | Tags,       |             | Tags        | Tags        |
-|                   | Analysis,   | MusicBrainz |             | MusicBrainz |             |             |             |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| External Sources  | ffmpeg      | MusicBrainz |             | MusicBrainz |             |             | None        |
-|                   |             |             |             |             |             |             |             |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| File management   | By user only| Renameing / | None        |             | None        | None        | None        |
-|                   |             | Moving      |             |             |             |             |             |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| File meta data    | None        | Read/Write  | Read        | Read?       | Read?       | Read        | Read        |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Artwork managing  | Yes         |             |             |             |             |             | No          |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Lyrics managing   | Yes         |             |             | No          | No          |             | No          |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Export            | Yes         | Yes         | No          | No          | No          | No          | No          |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Streaming         | Yes         | Yes         | No          | Yes         | No          | Yes         | Yes         |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| UI                | CLI/WebUI   | CLI         | WebUI       | CLI/WebUI   | WebUI       | CLI/(1)     | CLI/(2)     |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Playlist          | Queue,      |             | Playlist,   | Playlist,   | Playlist,   | Playlist    | Queue,      |
-|                   | Random      |             | Queue,      | Random      | Queue,      |             | Playlist,   |
-|                   |             |             | Random      |             | Random      |             | Random      |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-| Multiuser         | No          |             | Yes         | Yes         | Yes         | No          | Yes         |
-+-------------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
-
-(1):
-   There are extensions to access the server from the `web <https://docs.mopidy.com/en/latest/ext/web/#ext-web>`_.
-   *Modipy* also supports `MPD Clients <https://docs.mopidy.com/en/latest/clients/mpd/>`_.
-
-(2):
-   There exist also `Music Player Daemon Clients <https://www.musicpd.org/clients/>`_
 
 Conclusion
 ----------
 
 If you are looking for something like Spotify you should try `Ampache <http://ampache.org/index.html>`_.
 In case you only want to access your music from your web browser, 
 then `Sonerezh <https://www.sonerezh.bzh/>`_ 
-and `CherryMusic <http://www.fomori.org/cherrymusic/index.html>`_ are a good choice.
+and `CherryMusic <https://github.com/devsnd/cherrymusic>`_ are a good choice.
 When you have a totally messed up collection of files you want to organize, the `Beets <http://beets.io/>`_ is the tool you need and you should start with.
 **MusicDB** is for those who manage their files by himself and want to have music centric WebUI and streaming solution.
 If you cannot live with any of those tools and you want to develop your own solution, 

docs/build/html/_sources/basics/concept.rst.txt

@@ -7,35 +7,35 @@ They define what MusicDB is, and what it isn't.
 The order of the rules defines their priority.
 The nested list elements highlight some important implications of the philosophy.
 
-#. The filesystem is always right
+#. The file system is always right.
 
-   * Meta data in files have to be considered wrong
-   * The filesystem must be able to handle file names with Unicode
-   * The user has to care about a proper naming of the files
-   * The database is just for cache and augmentation
+   * Meta data in files have to be considered wrong.
+   * The file system must be able to handle file names with Unicode.
+   * The user has to care about a proper naming of the files. MusicDB can support the user with naming, but must not bypass the user.
+   * The database is just for cache and augmentation.
 
-#. The show must go on
+#. The show must go on.
 
-   * when errors occur, the software has to go back to a save state and ignore the action that causes the error
-   * If one feature is broken, the rest of the software must be able to continue its work
+   * when errors occur, the software has to go back to a save state and ignore the action that causes the error.
+   * If one feature is broken, the rest of the software must be able to continue its work.
 
-#. Bugs must be fixable in less than 15 minutes
+#. Bugs must be fixable in less than 15 minutes.
 
-   * If the *Show must go on* rule fails, it must be possible to identify and fix the bug in less 15 minutes
-   * Log everything the software does
-   * The code must be easy to read, not sophisticated
+   * If the *Show must go on* rule fails, it must be possible to identify and fix the bug in less 15 minutes.
+   * Log everything the software does.
+   * The code must be easy to read, not sophisticated.
 
-#. The GUI is not for managing music, it is for presenting the music
+#. The GUI is for presenting the music, not for controlling software.
 
-   * No control/management buttons if not absolutely necessary
-   * The current playing song is the "hero" and in focus of the presentation
+   * No control/management buttons if not absolutely necessary.
+   * The current playing song is the "hero" and in focus of the presentation.
    * No playlist management, only an easy to handle queue.
-   * Management shall be done via command line tools
+   * Strict separation between consuming music, and managing music .
 
 #. The user is always right. Software is just a tool under full control of the user.
 
-   * The software must follow the users decision and not question it
-   * AI and other algorithms shall not replace the users action and decision, just give hints and good defaults
-   * Every decision made by AI or other algorithms must be approved or denied by the user
-   * The source music collection of the user shall be considered read-only
+   * The software must follow the users decision and not question it.
+   * AI and other algorithms shall not replace the users action and decision, just give hints and good defaults.
+   * Every decision made by AI or other algorithms must be approved or denied by the user.
+   * The source music collection of the user shall be considered sacred. Only apply changes if the user explicitly asks for it.