[doc] Add configuration documentation

[doc] Fix capitalisation of macOS
2024-04-22 17:32:53 +02:00 · 2024-04-22 17:32:26 +02:00
4 changed files with 1254 additions and 24 deletions
--- a/README.md
+++ b/README.md
@ -9,10 +9,10 @@ You control the server via a web interface, Apple Remote, an Android remote
 (e.g. Retune), an MPD client, json API or DACP.

 OwnTone also serves local files via the Digital Audio Access Protocol (DAAP) to
-iTunes (Windows), Apple Music (MacOS) and Rhythmbox (Linux), and via the Roku
+iTunes (Windows), Apple Music (macOS) and Rhythmbox (Linux), and via the Roku
 Server Protocol (RSP) to Roku devices.

-Runs on Linux, BSD and MacOS.
+Runs on Linux, BSD and macOS.

 OwnTone was previously called forked-daapd, which again was a rewrite of
 mt-daapd (Firefly Media Server).
--- a/docs/clients/supported-clients.md
+++ b/docs/clients/supported-clients.md
@ -1,4 +1,4 @@
-# Supported clients
+# Supported Clients

 OwnTone supports these kinds of clients:

@ -22,21 +22,21 @@ connect without authentication. You can change that in the configuration file.
 Here is a list of working and non-working DAAP and Remote clients. The list is
 probably obsolete when you read it :-)

-|          Client          | Developer   |  Type  |   Platform    | Working (vers.) |
-| ------------------------ | ----------- | ------ | ------------- | --------------- |
-| iTunes                   | Apple       | DAAP   | Win           | Yes (12.10.1)   |
-| Apple Music              | Apple       | DAAP   | MacOS         | Yes              |
-| Rhythmbox                | Gnome       | DAAP   | Linux         | Yes             |
-| Diapente                 | diapente    | DAAP   | Android       | Yes             |
-| WinAmp DAAPClient        | WardFamily  | DAAP   | WinAmp        | Yes             |
-| Amarok w/DAAP plugin     | KDE         | DAAP   | Linux/Win     | Yes (2.8.0)     |
-| Banshee                  |             | DAAP   | Linux/Win/OSX | No (2.6.2)      |
-| jtunes4                  |             | DAAP   | Java          | No              |
-| Firefly Client           |             | (DAAP) | Java          | No              |
-| Remote                   | Apple       | Remote | iOS           | Yes (4.3)       |
-| Retune                   | SquallyDoc  | Remote | Android       | Yes (3.5.23)    |
-| TunesRemote+             | Melloware   | Remote | Android       | Yes (2.5.3)     |
-| Remote for iTunes        | Hyperfine   | Remote | Android       | Yes             |
-| Remote for Windows Phone | Komodex     | Remote | Windows Phone | Yes (2.2.1.0)   |
-| TunesRemote SE           |             | Remote | Java          | Yes (r108)      |
-| rtRemote for Windows     | bizmodeller | Remote | Windows       | Yes (1.2.0.67)  |
+|          Client          | Developer   |  Type  |   Platform      | Working (vers.) |
+| ------------------------ | ----------- | ------ | --------------- | --------------- |
+| iTunes                   | Apple       | DAAP   | Win             | Yes (12.10.1)   |
+| Apple Music              | Apple       | DAAP   | macOS           | Yes              |
+| Rhythmbox                | Gnome       | DAAP   | Linux           | Yes             |
+| Diapente                 | diapente    | DAAP   | Android         | Yes             |
+| WinAmp DAAPClient        | WardFamily  | DAAP   | WinAmp          | Yes             |
+| Amarok w/DAAP plugin     | KDE         | DAAP   | Linux/Win       | Yes (2.8.0)     |
+| Banshee                  |             | DAAP   | Linux/Win/macOS | No (2.6.2)      |
+| jtunes4                  |             | DAAP   | Java            | No              |
+| Firefly Client           |             | (DAAP) | Java            | No              |
+| Remote                   | Apple       | Remote | iOS             | Yes (4.3)       |
+| Retune                   | SquallyDoc  | Remote | Android         | Yes (3.5.23)    |
+| TunesRemote+             | Melloware   | Remote | Android         | Yes (2.5.3)     |
+| Remote for iTunes        | Hyperfine   | Remote | Android         | Yes             |
+| Remote for Windows Phone | Komodex     | Remote | Windows Phone   | Yes (2.2.1.0)   |
+| TunesRemote SE           |             | Remote | Java            | Yes (r108)      |
+| rtRemote for Windows     | bizmodeller | Remote | Windows         | Yes (1.2.0.67)  |
--- a/docs/configuration.md
+++ b/docs/configuration.md
--- a/docs/index.md
+++ b/docs/index.md
@ -7,10 +7,10 @@ hide:
 # OwnTone

 **OwnTone** is an open source (audio) media server for GNU/Linux, FreeBSD
-and MacOS.
+and macOS.

 It allows sharing and streaming your media library to iTunes (DAAP[^1]),
-Roku (RSP), AirPlay devices (multiroom), Chromecast and also supports local
+Roku (RSP), AirPlay devices (multi-room), Chromecast and also supports local
 playback.

 You can control OwnTone via its web interface, Apple Remote (and compatible
@ -78,4 +78,4 @@ please see the documentation on [Building from Source](installation.md).

 You can find source and documentation, also for older versions, here:

- [https://github.com/owntone/owntone-server.git](https://github.com/owntone/owntone-server.git)
+- [Source Code](https://github.com/owntone/owntone-server.git)
Author	SHA1	Message	Date
Alain Nussbaumer	52a915c8a0	[doc] Add configuration documentation	2024-04-22 17:32:53 +02:00
Alain Nussbaumer	67e67c8db9	[doc] Fix capitalisation of macOS	2024-04-22 17:32:26 +02:00