Refer to the review guidelines

Reduce the duplication. We still explain the basic setup here, but refer to the review guidelines for details.
This commit is contained in:
Matthias Clasen
2017-04-13 08:26:41 -04:00
committed by GitHub
parent 5a8773f8ab
commit b55dbed202
+9 -25
View File
@@ -1,40 +1,24 @@
Flathub
-------
Flathub is the central place for building and hosting flatpak builds.
Flathub is the central place for building and hosting Flatpak builds.
Go to http://flathub.org/builds/#/ to see Flathub in action.
Building applications
---------------------
Application manifests should go in their own branches, named after the application ID.
Application manifests should go in their own repository in the [Flathub](http://github.com/flathub) organization,
named after the application ID.
For example, for gnome-recipes, there is a branch named org.gnome.Recipes which has
the org.gnome.Recipes.json file at the toplevel.
For example, for gnome-recipes, there is a repository named org.gnome.Recipes which has the org.gnome.Recipes.json
file at the toplevel.
The manifests should build releases, not development snapshots, so please use
tarballs or git tags, not just the tip of a branch.
Hosted builds should be stable releases, not development snapshots, so please use tarballs or git tags, not just
the tip of a branch.
In case you build from a git tag, please specify both the tag name and the commit id, like so:
```
"branch": "1.0.4",
"commit": "cdfb19b90587bc0c44404fae30c139f9ec1cca5c"
```
This makes the build repeatable, since a tag can otherwise change its value over time.
You can also use only a commit, but specifying a tag name if there is one is good for readability.
More detailed requirements can be found in the [Review Guidelines](https://github.com/flatpak/flathub/wiki/Review-Guidelines)
Flathub always builds in the flatpak branchname "stable", and it always passes --default-name=stable,
so you don't need to specify a branch key. But if you do (not recommended), it must be "stable".
Flathub requires that you build against an sdk that is itself hosted on Flathub. The same goes for
sdk extensions that may be required to build your application. The easiest way to see what runtimes
are currently available is to install the flathub remote and use
```
flatpak remote-ls --runtime flathub
```
All applications in flathub should ship with appstream data.
Using the flathub repository
Using the Flathub repository
----------------------------
To install applications that are hosted on Flathub, use the following: