Guidelines and HOWTOs/AppStream

Quick guide on how to AppStream your app. For a more in-depth overview hop on over to Techbase.

Checklist

Assuming your software is named "foo"...

1. Make sure your desktop file is reverse-domain-notation i.e. org.kde.foo
   1. Your desktop file should be org.kde.foo.desktop. This is also your desktop-id, so whenver you may need that. It's basically your file name.
   2. If you have a D-Bus service ... make sure that your D-Bus service name matches this or change your desktop file to match the service address (whichever seems more appropriate)
   3. The name part 'foo' MUST be the name of your binary. If it should be different you need to either use KAboutData::setDesktopFileName() or, if not using KAboutData, QGuiApplication::setDesktopFileName() to set the desktop file name you are using for the app's runtime metadata
2. Create a file org.kde.foo.appdata.xml in your source tree
3. Paste the template you can find below (see section Template) into that file
4. Make sure you replaced all place holders from the template
5. Take some screenshots and put them in the git repo kde:websites/product-screenshots (note the README.md)
6. Add the CDN links to your screenshots to the appdata.xml file.
7. Install the file via CMake (KDE_INSTALL_METAINFODIR is defined by KDEInstallDirs from extra-cmake-modules)

   install(FILES org.kde.foo.appdata.xml DESTINATION ${KDE_INSTALL_METAINFODIR})
   

8. Validate your appdata using the appstreamcli helper

   appstreamcli validate org.kde.foo.appdata.xml

9. Validate your installed tree using the helper in your build directory

   make
   make install DESTDIR=root
   appstreamcli validate-tree root
   rm -r root
   

10. If all looks good commit and push
11. If you have any questions submit a review and make sure to subscribe sitter and mak

Template

Carefully review all fields and replace all $VARIABLES ($NAME with your application name as seen in the reverse domain notation). Where appropriate the fields have URLs of respective AppStream documentation to help you find out what to put there.

<?xml version="1.0" encoding="utf-8"?>
<component type="desktop">
  <id>org.kde.$NAME.desktop</id>
  <metadata_license>CC0-1.0</metadata_license>
  <project_license> see https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-metadata_license </project_license>
  <name>$NAME</name>
  <summary> see https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-summary </summary>
  <description>
    <p> see https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-description </p>
    <p>And see.</p>
    <p>And see:</p>
    <ul>
      <li>this</li>
      <li>that</li>
    </ul>
  </description>
  <url type="homepage">https://www.kde.org</url>
  <url type="bugtracker">https://bugs.kde.org/enter_bug.cgi?format=guided&amp;product=$YOURPRODUCTNAME</url>
  <url type="donation">https://www.kde.org/community/donations/?app=$YOURBINARYNAME</url>
  <screenshots>
    <screenshot type="default">
      <image>
        see https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-screenshots
        Central hosting for uploading at https://phabricator.kde.org/source/websites-product-screenshots/
        Central URL to use here https://cdn.kde.org/screenshots/...
      </image>
    </screenshot>
  </screenshots>
  <provides>
    <binary>$YOURBINARYNAME</binary>
  </provides>
  <project_group>KDE</project_group>
</component>