[Initiatives.wiki] Update App Metadata



commit da41d4c5cb40fdd621da6539a07587d06a36b0c3
Author: Sophie Herold <sophie hemio de>
Date:   Tue Aug 3 20:57:24 2021 +0000

    Update App Metadata

 App-Metadata.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)
---
diff --git a/App-Metadata.md b/App-Metadata.md
index d2b0649..89fac7e 100644
--- a/App-Metadata.md
+++ b/App-Metadata.md
@@ -1,3 +1,14 @@
+## Name
+
+General guidance:
+- Use the same name as provided in the desktop file
+- [Follow the app naming guidelines](https://developer.gnome.org/hig/guidelines/app-naming.html)
+
+Avoid:
+- Mentioning the target environment (e.g. "GNOME X")
+
+[Appstream documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-name)
+
 ## 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.
@@ -49,6 +60,8 @@ Bad Examples:
 
 ## Screenshots
 
+**TODO: Recommend to (not) use scaling/HighDPI?**  
+
 General guidance:
 - Provide multiple screenshots showing off the main areas of the app
 - Show off the app with realistic and good-looking example content
@@ -59,11 +72,32 @@ Avoid:
 - Using a non-standard system stylesheet or icons
 - Using non-standard window decorations (e.g. minimize/maximize enabled)
 
-
 [Appstream 
documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-screenshots)
 
+## Custom
+
+[Appstream documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-custom)
+
+### Key Colors
+
+**TODO: I don't
+
+General guidance:
+- Only add key-colors if the automatically detected colors in tools (e.g. Software) using this feature are 
not adequate
+- 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/)?**
+
 ## README
 
 ## Repository Icon
 
+**TODO: This is possibly outdated.**
+
 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


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]