Update documentation for Flatpak

LizardByte · Jun 18, 2022 · 0df98cd · 0df98cd
1 parent 8509260
commit 0df98cd
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 16 deletions.
diff --git a/.github/workflows/CI.yml b/.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

diff --git a/docs/source/about/installation.rst b/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
-^^^^^^^^^^^^^^^
-.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:debian?logo=github&style=for-the-badge
+Debian Package
+^^^^^^^^^^^^^^
+.. 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,21 @@ Debian Packages
 
 .. Tip:: You can double click the deb file to see details about the package and begin installation.
 
-Red Hat Packages
-^^^^^^^^^^^^^^^^
-.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:fedora?logo=github&style=for-the-badge
+Flatpak Package
+^^^^^^^^^^^^^^^
+.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:flatpak?logo=github&style=for-the-badge
+   :alt: GitHub issues by-label
+
+#. Install `Flatpak <https://flatpak.org/setup/>`_ as required.
+#. Download ``sunshine.flatpak`` and run the following code.
+
+   .. code-block:: bash
+
+      flatpak install --system 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.

diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst
@@ -100,13 +100,14 @@ Configure autostart service
       .. table::
          :widths: auto
 
-         ========   ===================   ===============
-         package    ExecStart             Auto Configured
-         ========   ===================   ===============
-         deb        /usr/bin/sunshine     ✔
-         rpm        /usr/bin/sunshine     ✔
-         AppImage   ~/sunshine.AppImage   ✖
-         ========   ===================   ===============
+         ========   ==============================================   ===============
+         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