[Initiatives.wiki] Update App Metadata
- From: Sophie Herold <sophieherold src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [Initiatives.wiki] Update App Metadata
- Date: Mon, 6 Dec 2021 01:31:56 +0000 (UTC)
commit 8714436a723e526f3ea27b1582a127a3ecc6f5ab
Author: Sophie Herold <sophie hemio de>
Date: Mon Dec 6 01:31:54 2021 +0000
Update App Metadata
App-Metadata.md | 60 ++++++++++++++++++++++++++++++---------------------------
1 file changed, 32 insertions(+), 28 deletions(-)
---
diff --git a/App-Metadata.md b/App-Metadata.md
index e6e4089..ab4ac12 100644
--- a/App-Metadata.md
+++ b/App-Metadata.md
@@ -1,4 +1,20 @@
-## Name
+**Table of Contents**
+
+[[_TOC_]]
+
+## Checking a Project
+
+The use of the project's metadata can be checked on
+
+- [apps.gnome.org](https://apps.gnome.org)
+- [flathub.org](https://www.flathub.org)
+- [Software](https://apps.gnome.org/app/org.gnome.Software/)
+
+## Metadata
+
+### AppStream Metainfo
+
+#### Name
General guidance:
- Use the same name as provided in the desktop file
@@ -9,7 +25,7 @@ Avoid:
[Appstream documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-name)
-## Summary
+#### Summary
The summary should answer the question **"What superpower does this app give me?"**. It doesn't need to
comprehensively describe everything the app does, as long as it highlights one important aspect and makes it
clear why it's valuable.
@@ -41,28 +57,29 @@ Bad Examples:
[Appstream documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-summary)
-## Description
+#### Description
[Appstream
documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-description)
-## Developer name
+#### Developer name
[Appstream
documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-developer_name
)
-## Links
+#### Links
[Appstream documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-url)
-## Release Notes
+#### Release Notes (?)
-[Appstream
documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-releases)
+**I would suggest removing this because it is out of scope for this initiative.**
-## Screenshots
+[Appstream
documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-releases)
-**TODO: Recommend to (not) use scaling/HighDPI?**
+#### Screenshots
General guidance:
+- Use 100% scale (no "High DPI") setting until screenshot scales [are
supported](https://github.com/ximion/appstream/issues/114)
- Provide multiple screenshots showing off the main areas of the app
- Show off the app with realistic and good-looking example content
- Update screenshots when the app UI changes
@@ -74,29 +91,16 @@ Avoid:
[Appstream
documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-screenshots)
-## Custom
+#### Custom
[Appstream documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-custom)
-### Key Colors
-
-**TODO: I don't know of any specification for this.**
-
-General guidance:
-- Provide a color with sufficient contrast to the app icon as the first entry
-- Provide at least one additional color that has [good
contrast](https://flathub.org/apps/details/org.gnome.design.Contrast) to the first color entry
-
-Avoid:
-- Colors that don't harmonize with each other or with the app icon
-
-### Form Factor
-
-**TODO: Do we want
[Purism::form_factor](https://puri.sm/posts/specify-form-factors-in-your-librem-5-apps/)?**
+##### Key Colors
-## README
+- [See GNOME Software
Wiki](https://gitlab.gnome.org/GNOME/gnome-software/-/wikis/Software-metadata#how-to-set-the-carousel-tile-background-colour)
-## Repository Icon
+### README
-**TODO: This is possibly outdated.**
+### Repository Icon
-The Gitlab repository icon should be the regular app icon with a baked-in shadow. We have plans to add a way
to automatically export a PNG with a baked-in shadow from App Icon Preview for this purpose.
\ No newline at end of file
+- Generate via the [Emblem](https://apps.gnome.org/app/org.gnome.design.Emblem/) app
\ No newline at end of file
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]