Browse Source

Add Documentation on Flatpaks

Felix Turo 2 years ago
parent
commit
e1c05688ea

+ 40 - 0
docs/deployment/linux-flatpak/flatpak_creation.md

@@ -0,0 +1,40 @@
+# To Do
+
+Create a repository to host the flatpak and upload to flathub
+
+# For now - How to create a local flatpak
+
+## Requirements
+
+Install flatpak and the required Platform and make sure they match the versions in the `yaml` file. Details on the [docs](https://docs.flatpak.org/en/latest/first-build.html)
+
+```bash
+flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
+
+flatpak install flathub org.kde.Sdk
+flatpak install flathub org.kde.Platform
+```
+
+## Build the package
+
+Build the package and add it to a repository - `repo` in this case. Add the repository.
+
+```bash
+# flatpak-builder --repo=repo --user --install --farce-clean [build directory] [manifest file]
+
+flatpak-builder --repo=repo --user --install --force-clean ~/git/flatpak-builddir ~/Documents/org.opl.openPilotLog.yaml 
+
+flatpak --user remote-add --no-gpg-verify repo repo
+```
+Build an [application bundle](https://docs.flatpak.org/en/latest/single-file-bundles.html) from the local repository
+```bash
+# flatpak build-bundle [repository] [bundle name] [application name]
+flatpak build-bundle repo openPilotLog.flatpak org.opl.openPilotLog
+```
+## Install the flatpak package locally
+
+On the target machine, navigate to the download directory and install the .flatpak file
+
+```bash
+flatpak install --user openPilotLog.flatpak
+````

+ 3 - 3
docs/deployment/linux-flatpak/org.opl.openPilotLog.yaml

@@ -1,6 +1,6 @@
 id: org.opl.openPilotLog
 runtime: org.kde.Platform
-runtime-version: '5.15'
+runtime-version: '5.15-21.08'
 sdk: org.kde.Sdk
 command: openPilotLog
 finish-args:
@@ -12,8 +12,8 @@ finish-args:
   - --device=dri
 modules:
   - name: openPilotLog
-    buildsystem: cmake
+    buildsystem: cmake-ninja
     sources:
       - type: git
         url: https://github.com/fiffty-50/openpilotlog
-        branch: develop
+        branch: main