From 1d4f01e95d2048efd1ea8e91c163688bde147851 Mon Sep 17 00:00:00 2001 From: Alexander Larsson Date: Mon, 10 Apr 2017 17:33:35 +0200 Subject: [PATCH] Update README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index df6a958..b66caac 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,16 @@ 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. + +In case you build from a git tag, please specify both the tag name and the commit id, liks 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 specifing a tag name if there is one is good for readability. + +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". + +All applications in flathub should ship with appstream data.