@@ -1,27 +1,25 @@
1−# Flathub
1+This is where the magic happens.
22
3−Flathub is the central place for building and hosting Flatpak builds.
3+Application manifests should go in their own branches, named after the application ID.
44
5−Using the Flathub repository
6−----------------------------
5+For example, for gnome-recipes, there is a branch named org.gnome.Recipes which has
6+the org.gnome.Recipes.json file at the toplevel.
77
8−To install applications that are hosted on Flathub, use the following:
9−```
10−flatpak remote-add flathub https://flathub.org/repo/flathub.flatpakrepo
11−flatpak install flathub org.gnome.Recipes
12−```
8+The manifests should build releases, not development snapshots, so please use
9+tarballs or git tags, not just the tip of a branch.
1310
14−To install applications from the beta branch, use the following:
11+In case you build from a git tag, please specify both the tag name and the commit id, like so:
1512```
16−flatpak remote-add flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
17−flatpak install flathub-beta org.godotengine.Godot
13+ "branch": "1.0.4",
14+ "commit": "cdfb19b90587bc0c44404fae30c139f9ec1cca5c"
1815```
16+This makes the build repeatable, since a tag can otherwise change its value over time.
17+You can also use only a commit, but specifying a tag name if there is one is good for readability.
1918
20−For more information and more applications see https://flathub.org
21−
22−Contributing to Flathub
23−-----------------------
19+Flathub always builds in the flatpak branchname "stable", and it always passes --default-name=stable,
20+so you don't need to specify a branch key. But if you do (not recommended), it must be "stable".
2421
25−For information on creating packages or reporting issues please see the [contributing page](/CONTRIBUTING.md).
22+Flathub requires that you build against an sdk that is itself hosted on Flathub. The same goes for
23+sdk extensions that may be required to build your application.
2624
27−***Note:*** *this repository is not for reporting issues related to the flathub.org website itself or contributing to its development. For that, go to https://github.com/flathub/website*
25+All applications in flathub should ship with appstream data.