From 89961dbe431a0b04fd82f985d7ee8194297d6aa7 Mon Sep 17 00:00:00 2001
From: Jakob Meier <comcloudway@ccw.icu>
Date: Sun, 3 Mar 2024 16:19:35 +0100
Subject: [PATCH] add manuall flatpak packaging instruction

---
 README.md                  | 10 +++++-
 flatpak/README.md          | 63 ++++++++++++++++++++++++++++++++++++++
 flatpak/icu.ccw.Melon.json |  2 +-
 flatpak/icu.ccw.Melon.yml  |  2 +-
 4 files changed, 74 insertions(+), 3 deletions(-)
 create mode 100644 flatpak/README.md

diff --git a/README.md b/README.md
index f5a3b10..87b3973 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,14 @@ Normally this website should be on the service instance itself,
 however the following plugins currently rely on external services:
 - `nebula`: uses [HLSPlayer.org](https://www.hlsplayer.org/) for video playback
 
+## 📦 Packages
+There are currently no prebuilt packages available,
+however you can build [the Flatpak yourself](./flatpak/README.md).
+
+If you are running an [Alpine Linux](https://alpinelinux.org/) based distro,
+like [postmarketOS](https://postmarketos.org/), 
+you can also get the APKBUILD from my [personal APKBUILD-repo](https://git.hut.ccw.icu/~comcloudway/ccw-aports)
+
 ## 📸 Screenshots
 ![Screenshot of melon home screen, showing the What's new tab](./screenshots/home.png)
 
@@ -62,7 +70,7 @@ Of course, you are welcome to send issues and pull requests via email as well:
 - `libadwaita`
 - `webkit2gtk-6.0`
 
-## Translations
+## 🌍 Translations
 Melon supports multiple languages.
 If you want to help translate Melon into your language,
 head over to [Weblate](https://translate.codeberg.org/engage/melon/)
diff --git a/flatpak/README.md b/flatpak/README.md
new file mode 100644
index 0000000..3c177a1
--- /dev/null
+++ b/flatpak/README.md
@@ -0,0 +1,63 @@
+# 📦 Flatpak
+
+Melon is available via [Flatpak](https://www.flatpak.org/),
+although there is currently no prebuilt package,
+you can use the following steps to build the flatpak yourself.
+
+## 🔨 Manually build the Flatpak
+This guide is mostly taken from the [Build your first Flatpak Guide](https://docs.flatpak.org/en/latest/first-build.html).
+
+First of all, 
+make sure you have `flatpak-builder` installed.
+You can probably get this from your system repository.
+
+Additionally, 
+you will need to clone the [melon git repo](https://codeberg.org/comcloudway/melon).
+Either by downloading the repo archive or by using `git`:
+```sh
+git clone https://codeberg.org/comcloudway/melon
+cd melon
+```
+
+Now that you have access to the `flatpak-builder`,
+navigate into the `flatpak` directory of the `melon` source
+```sh
+cd flatpak
+```
+
+build the project using:
+```sh
+flatpak-builder build icu.ccw.Melon.yml --force-clean
+```
+
+If you want to build a different version than you local version,
+have a look at the comments in the `icu.ccw.Melon.yml` file.
+
+After building the flatpak,
+you can validate it, by installing it locally:
+```sh
+flatpak-builder --user --install --force-clean build icu.ccw.Melon.yml
+```
+
+And run it:
+```sh
+flatpak run icu.ccw.melon
+```
+
+To properly install the app,
+add it to a repository:
+```sh
+flatpak-builder --repo=melon-src --force-clean build icu.ccw.Melon.yml
+```
+
+Add that repository to your local repositories
+```sh
+flatpak --user remote-add --no-gpg-verify melon-src melon-src
+```
+
+And install the app from the newly added repository:
+```sh
+flatpak --user install melon-src icu.ccw.Melon
+```
+
+NOTE: You might have to uninstall the version you've installed earlier
diff --git a/flatpak/icu.ccw.Melon.json b/flatpak/icu.ccw.Melon.json
index fdf1be3..d249447 100644
--- a/flatpak/icu.ccw.Melon.json
+++ b/flatpak/icu.ccw.Melon.json
@@ -1,5 +1,5 @@
 {
-    "app-id" : "icu.ccw.melon",
+    "app-id" : "icu.ccw.Melon",
     "runtime" : "org.gnome.Platform",
     "runtime-version" : "45",
     "sdk" : "org.gnome.Sdk",
diff --git a/flatpak/icu.ccw.Melon.yml b/flatpak/icu.ccw.Melon.yml
index a6e670c..789ad74 100644
--- a/flatpak/icu.ccw.Melon.yml
+++ b/flatpak/icu.ccw.Melon.yml
@@ -1,5 +1,5 @@
 ---
-app-id: icu.ccw.melon
+app-id: icu.ccw.Melon
 runtime: org.gnome.Platform
 runtime-version: '45'
 sdk: org.gnome.Sdk
-- 
2.38.5