Update documentation. Add reference to binary installer.

MayaPosch · Dec 13, 2021 · c8f26ff · c8f26ff
1 parent d6b46a6
commit c8f26ff
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ The current development version is v0.1-beta0. Version 0.1 will be the first rel
 
 Category | Status | Description | Notes
 ---|----|---|---
-File Streaming |95% | Streaming media files from client to server | Meta-info & playback status reporting need more testing.
+File Streaming |100% | Streaming media files from client to server | 
 Subtitles & streams | 75% | Subtitle & stream selection support | Implemented but untested.
 MediaServer | 100% | Streaming from NymphCast MediaServer instances | 
 URL Streaming | 100% | Streaming from URLs | 
@@ -140,7 +140,7 @@ To start using NymphCast, you need a device on which the server will be running
 
 ### **Releases** ###
 
-NymphCast is currently in Alpha stage. Experimental releases are available on Github (see the ['Releases'](https://github.com/MayaPosch/NymphCast/releases) folder).
+NymphCast is currently in Beta stage. Releases are available on Github (see the ['Releases'](https://github.com/MayaPosch/NymphCast/releases) folder).
 
 Some packages also exist for selected distros.
 
@@ -156,7 +156,7 @@ Player client releases for **Android** and **Windows**:
 * APK for installation on Android, see ['Releases'](https://github.com/MayaPosch/NymphCast/releases) 
 * desktop client for Windows(x64), see ['Releases'](https://github.com/MayaPosch/NymphCast/releases)   
 
-If pre-compiled releases for your target device or operating system are currently not listed above, you may need to build the server and client applications from source.
+If pre-compiled releases for your target device or operating system are currently not listed above or on the releases page, you may need to build the server and client applications from source. See the Setup Guides listed under the Usage Scenarios section at the beginning of this document.
 
 
 ### **Running NymphCast** ###

diff --git a/doc/nymphcast_audio_setup_guide.md b/doc/nymphcast_audio_setup_guide.md
@@ -21,6 +21,22 @@ In order to set up an NC-A system, the following hardware and software requireme
 
 For detailed requirements, see the [Compiling NymphCast Server manually](building_nymphcast_server.md) documentation.
 
+## Binary installer ##
+
+For Raspberry Pi single-board computers (SBCs) a binary installer (for legacy Buster & current Bullseye) is provided on the ['Releases'](https://github.com/MayaPosch/NymphCast/releases) page. These are `.tar.gz` files containing the binary files for NymphCast Server and dependencies.
+
+Simply extract the archive and run the contained `install.sh` script:
+
+```
+tar -xvf nymphcast_server-<version>-<platform>.tar.gz
+cd nymphcast_server-version>-<platform>
+sudo ./install.sh
+```
+
+During this process any needed dependencies will be downloaded and installed using Debian's package manager.
+
+The installer will also ask whether to install a systemd service for NymphCast service, and ask which mode to configure the service for. For audio mode, choose `audio` here.
+
 ## Setup: Linux ##
 
 These instructions are targeted at Linux-based systems, as well as Linux-compatible environments, such as MacOS and BSD. NymphCast has been tested on:

diff --git a/doc/nymphcast_gui_setup_guide.md b/doc/nymphcast_gui_setup_guide.md
@@ -26,6 +26,22 @@ In order to set up an NC-G system, the following hardware and software requireme
 
 For detailed requirements, see the [Compiling NymphCast Server manually](building_nymphcast_server.md) documentation.
 
+## Binary installer ##
+
+For Raspberry Pi single-board computers (SBCs) a binary installer (for legacy Buster & current Bullseye) is provided on the ['Releases'](https://github.com/MayaPosch/NymphCast/releases) page. These are `.tar.gz` files containing the binary files for NymphCast Server and dependencies.
+
+Simply extract the archive and run the contained `install.sh` script:
+
+```
+tar -xvf nymphcast_server-<version>-<platform>.tar.gz
+cd nymphcast_server-version>-<platform>
+sudo ./install.sh
+```
+
+During this process any needed dependencies will be downloaded and installed using Debian's package manager.
+
+The installer will also ask whether to install a systemd service for NymphCast service, and ask which mode to configure the service for. For GUI mode, choose `gui` here.
+
 
 ## GUI configuration ##
 

diff --git a/doc/nymphcast_screensaver_setup_guide.md b/doc/nymphcast_screensaver_setup_guide.md
@@ -24,6 +24,22 @@ In order to set up an NC-S system, the following hardware and software requireme
 
 For detailed requirements, see the [Compiling NymphCast Server manually](building_nymphcast_server.md) documentation.
 
+## Binary installer ##
+
+For Raspberry Pi single-board computers (SBCs) a binary installer (for legacy Buster & current Bullseye) is provided on the ['Releases'](https://github.com/MayaPosch/NymphCast/releases) page. These are `.tar.gz` files containing the binary files for NymphCast Server and dependencies.
+
+Simply extract the archive and run the contained `install.sh` script:
+
+```
+tar -xvf nymphcast_server-<version>-<platform>.tar.gz
+cd nymphcast_server-version>-<platform>
+sudo ./install.sh
+```
+
+During this process any needed dependencies will be downloaded and installed using Debian's package manager.
+
+The installer will also ask whether to install a systemd service for NymphCast service, and ask which mode to configure the service for. For screensaver mode, choose `screensaver` here.
+
 ## Setup: Linux ##
 
 These instructions are targeted at Linux-based systems, as well as Linux-compatible environments, such as MacOS and BSD. NymphCast has been tested on:

diff --git a/doc/nymphcast_video_setup_guide.md b/doc/nymphcast_video_setup_guide.md
@@ -22,6 +22,22 @@ In order to set up an NC-V system, the following hardware and software requireme
 
 For detailed requirements, see the [Compiling NymphCast Server manually](building_nymphcast_server.md) documentation.
 
+## Binary installer ##
+
+For Raspberry Pi single-board computers (SBCs) a binary installer (for legacy Buster & current Bullseye) is provided on the ['Releases'](https://github.com/MayaPosch/NymphCast/releases) page. These are `.tar.gz` files containing the binary files for NymphCast Server and dependencies.
+
+Simply extract the archive and run the contained `install.sh` script:
+
+```
+tar -xvf nymphcast_server-<version>-<platform>.tar.gz
+cd nymphcast_server-version>-<platform>
+sudo ./install.sh
+```
+
+During this process any needed dependencies will be downloaded and installed using Debian's package manager.
+
+The installer will also ask whether to install a systemd service for NymphCast service, and ask which mode to configure the service for. For video mode, choose `video` here.
+
 ## Setup: Linux ##
 
 These instructions are targeted at Linux-based systems, as well as Linux-compatible environments, such as MacOS and BSD. NymphCast has been tested on: