From 7bc53840d340e5014c3935c33d10b00d043c3385 Mon Sep 17 00:00:00 2001 From: Jeremy Bicha Date: Tue, 20 Jun 2017 13:51:06 -0400 Subject: [PATCH 1/3] doc: Uncomment line in middle of paragraph --- docs/sources/quickstart/desktop-apps.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/quickstart/desktop-apps.xml b/docs/sources/quickstart/desktop-apps.xml index d536057f..7f29a4bf 100644 --- a/docs/sources/quickstart/desktop-apps.xml +++ b/docs/sources/quickstart/desktop-apps.xml @@ -14,7 +14,7 @@ For most users it allows them to answer the question Do I want to install this application?. Traditionally in Linux distributions, we have none of this data for the vast majority of our desktop user-installable applications. The packages-descriptions are describing all contents of a package, and not just a single application. They are also often written in a technical - + language and refer to other packages, which makes it hard for beginners to understand what the application they want to install really does. Additionally, if you are not using Debian or Ubuntu, the package descriptions are often untranslated. Also, packages do not provide some metadata users might be interested in before installing an application. From 13ccd9cb68097dd923e89cdf0809eb61cacac6b6 Mon Sep 17 00:00:00 2001 From: Jeremy Bicha Date: Tue, 20 Jun 2017 14:56:03 -0400 Subject: [PATCH 2/3] doc: trivial: remove a hyphen --- docs/sources/quickstart/addons.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/quickstart/addons.xml b/docs/sources/quickstart/addons.xml index c7123306..2708ef08 100644 --- a/docs/sources/quickstart/addons.xml +++ b/docs/sources/quickstart/addons.xml @@ -36,7 +36,7 @@ Metadata file contents This is a list of tags you might want to define for your application. For a full list of possible tags, take a look at - the definition of a generic component () and an addon-component (). + the definition of a generic component () and an addon component (). From 84bd97539635de01702ae60acc79dfa9b1ad1a40 Mon Sep 17 00:00:00 2001 From: Jeremy Bicha Date: Tue, 20 Jun 2017 14:56:53 -0400 Subject: [PATCH 3/3] doc: Add Distro Packaging page --- docs/sources/quickstart/Quickstart.xml | 1 + docs/sources/quickstart/packaging.xml | 38 ++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 docs/sources/quickstart/packaging.xml diff --git a/docs/sources/quickstart/Quickstart.xml b/docs/sources/quickstart/Quickstart.xml index cddc962e..a2e19f4a 100644 --- a/docs/sources/quickstart/Quickstart.xml +++ b/docs/sources/quickstart/Quickstart.xml @@ -14,6 +14,7 @@ + diff --git a/docs/sources/quickstart/packaging.xml b/docs/sources/quickstart/packaging.xml new file mode 100644 index 00000000..4d64b4e1 --- /dev/null +++ b/docs/sources/quickstart/packaging.xml @@ -0,0 +1,38 @@ + + +%BOOK_ENTITIES; +]> + +
+ For distributors packaging Appstream metadata + +
+ Guidelines for distributors + + Distributors of projects with AppStream metadata perform an important role + by making the software available to more people. There are a few guidelines + distributors should follow in order for software centers to present + the correct information to users. + +
+ +
+ Guidelines for distributors + + A binary package that contains AppStream desktop metadata () + must also contain both the .desktop file for the application and the application itself. + + + A binary package must not contain more than one AppStream metadata file. The one exception is + that it is permissable for a binary package that is extended by addons to include those addons + () and their AppStream metadata files. Note that users + will be unable to remove those addons separately. + + + Except for the extended package, no other package may contain more than one Appstream addon metadata file. + + +
+ +