Update documentation for Flatpak

.github/workflows/CI.yml

@@ -70,7 +70,7 @@ jobs:
       - name: Cache flatpak-builder
         uses: actions/cache@v3
         with:
-          path: ./build/.flatpak-builder
+          path: ./build/.flatpak-builder/build
           key: ${{ runner.os }}-flatpak-builder
 
       - name: Checkout

README.rst

@@ -2,6 +2,7 @@
 
 Overview
 ========
+SunshineStream has the full documentation hosted on `Read the Docs <http://sunshinestream.readthedocs.io/>`_.
 
 About
 -----

docs/source/about/installation.rst

@@ -28,7 +28,7 @@ AppImage
 .. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:appimage?logo=github&style=for-the-badge
    :alt: GitHub issues by-label
 
-The current known compatibility of the AppImage is shown below.
+According to AppImageLint the AppImage can run on the following distros.
 
    - [✖] Debian oldstable (buster)
    - [✔] Debian stable (bullseye)
@@ -42,11 +42,11 @@ The current known compatibility of the AppImage is shown below.
    - [✖] Ubuntu trusty
    - [✖] CentOS 7
 
-#. Download and extract ``sunshine-appimage.zip`` to your home directory.
+#. Download ``sunshine-appimage.zip`` and extract the contents to your home directory.
 
-Debian Packages
+Debian Package
-^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^
-.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:debian?logo=github&style=for-the-badge
+.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:deb?logo=github&style=for-the-badge
    :alt: GitHub issues by-label
 
 #. Download ``sunshine.deb`` and run the following code.
@@ -57,9 +57,29 @@ Debian Packages
 
 .. Tip:: You can double click the deb file to see details about the package and begin installation.
 
-Red Hat Packages
+Flatpak Package
-^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^
-.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:fedora?logo=github&style=for-the-badge
+.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:flatpak?logo=github&style=for-the-badge
+   :alt: GitHub issues by-label
+
+.. Todo:: This package needs to have CUDA added.
+
+#. Install `Flatpak <https://flatpak.org/setup/>`_ as required.
+#. Download ``sunshine.flatpak`` and run the following code.
+
+   System level (recommended)
+      .. code-block:: bash
+
+         flatpak install --system sunshine.flatpak
+
+   User level
+      .. code-block:: bash
+
+         flatpak install --user sunshine.flatpak
+
+RPM Package
+^^^^^^^^^^^
+.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:rpm?logo=github&style=for-the-badge
    :alt: GitHub issues by-label
 
 #. Add `rpmfusion` repositories by running the following code.

docs/source/about/usage.rst

@@ -33,7 +33,7 @@ Usage
 #. When Moonlight request you insert the correct pin on sunshine:
 
    - Login to the web ui
-   - Go to "PIN" in the Header
+   - Go to "PIN" in the Navbar
    - Type in your PIN and press Enter, you should get a Success Message
    - In Moonlight, select one of the Applications listed
 
@@ -60,13 +60,12 @@ The deb and rpm packages handle these steps automatically. The AppImage does not
 
 Sunshine needs access to `uinput` to create mouse and gamepad events.
 
-Add user to group `input`, if this is the first time installing.
+#. Add user to group `input`, if this is the first time installing.
       .. code-block:: bash
 
          sudo usermod -a -G input $USER
-      sudo reboot now
 
-Create `udev` rules.
+#. Create `udev` rules.
       .. code-block:: bash
 
          sudo nano /etc/udev/rules.d/85-sunshine-input.rules
@@ -82,7 +81,7 @@ Create `udev` rules.
          #. ``CTRL+X`` to start exit.
          #. ``Y`` to save modifications.
 
-Configure autostart service
+#. Optionally, configure autostart service
       - filename: ``~/.config/systemd/user/sunshine.service``
       - contents:
 
@@ -100,13 +99,14 @@ Configure autostart service
          .. table::
             :widths: auto
 
-         ========   ===================   ===============
+            ========   ==============================================   ===============
             package    ExecStart                                        Auto Configured
-         ========   ===================   ===============
+            ========   ==============================================   ===============
             deb        /usr/bin/sunshine                                ✔
             rpm        /usr/bin/sunshine                                ✔
             AppImage   ~/sunshine.AppImage                              ✖
-         ========   ===================   ===============
+            Flatpak    flatpak run com.github.sunshinestream.sunshine   ✖
+            ========   ==============================================   ===============
 
       Start once
          .. code-block:: bash
@@ -118,7 +118,7 @@ Configure autostart service
 
             systemctl --user enable sunshine
 
-Additional Setup for KMS
+#. Additional Setup for KMS
       .. Note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to
          allow Sunshine to use KMS.
 
@@ -132,6 +132,11 @@ Additional Setup for KMS
 
             sudo setcap -r $(readlink -f $(which sunshine))
 
+#. Reboot
+      .. code-block:: bash
+
+         sudo reboot now
+
 MacOS
 ^^^^^
 Sunshine can only access microphones on macOS due to system limitations. To stream system audio use

docs/source/index.rst

@@ -1,7 +1,5 @@
 :github_url: https://github.com/SunshineStream/Sunshine/tree/nightly/docs/source/index.rst
 
-SunshineStream has this documentation hosted on `Read the Docs <http://sunshinestream.readthedocs.io/>`_.
-
 Table of Contents
 =================
 .. include:: toc.rst