@@ -1,27 +1,45 @@
1−# Flathub
1+Flathub
2+-------
23
3−Flathub is the central place for building and hosting Flatpak builds.
4+Flathub is the central place for building and hosting flatpak builds.
5+Go to http://flathub.org/builds/#/ to see Flathub in action.
46
5−Using the Flathub repository
6−----------------------------
7+Building applications
8+---------------------
79
8−To install applications that are hosted on Flathub, use the following:
10+Application manifests should go in their own branches, named after the application ID.
11+
12+For example, for gnome-recipes, there is a branch named org.gnome.Recipes which has
13+the org.gnome.Recipes.json file at the toplevel.
14+
15+The manifests should build releases, not development snapshots, so please use
16+tarballs or git tags, not just the tip of a branch.
17+
18+In case you build from a git tag, please specify both the tag name and the commit id, like so:
919```
10−flatpak remote-add flathub https://flathub.org/repo/flathub.flatpakrepo
11−flatpak install flathub org.gnome.Recipes
20+ "branch": "1.0.4",
21+ "commit": "cdfb19b90587bc0c44404fae30c139f9ec1cca5c"
1222```
23+This makes the build repeatable, since a tag can otherwise change its value over time.
24+You can also use only a commit, but specifying a tag name if there is one is good for readability.
25+
26+Flathub always builds in the flatpak branchname "stable", and it always passes --default-name=stable,
27+so you don't need to specify a branch key. But if you do (not recommended), it must be "stable".
1328
14−To install applications from the beta branch, use the following:
29+Flathub requires that you build against an sdk that is itself hosted on Flathub. The same goes for
30+sdk extensions that may be required to build your application. The easiest way to see what runtimes
31+are currently available is to install the flathub remote and use
1532```
16−flatpak remote-add flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
17−flatpak install flathub-beta org.godotengine.Godot
33+flatpak remote-ls --runtime flathub
1834```
35+All applications in flathub should ship with appstream data.
1936
20−For more information and more applications see https://flathub.org
21−
22−Contributing to Flathub
23−-----------------------
37+Using the flathub repository
38+----------------------------
2439
25−For information on creating packages or reporting issues please see the [contributing page](/CONTRIBUTING.md).
40+To install applications that are hosted on Flathub, use the following:
41+```
42+flatpak remote-add flathub http://flathub.org/repo/flathub.flatpakrepo
43+flatpak --user install flathub org.gnome.Recipes
44+```
2645
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*