Metadata: Managing Updates Snapshots Parallel Installs Snapcraft Creating A Snap The Snapcraft Format
Metadata: Managing Updates Snapshots Parallel Installs Snapcraft Creating A Snap The Snapcraft Format
updates often
Snapshots Save, backup and restore the state of one or more installed snaps
Parallel installs Install more than one version of the same snap on your system
Building your own snaps:
Snapcraft Learn how to Install snapcraft and build your first snaps
overview
Creating a snap Step-by-step guides for Python, Go, Electron, pre-built binaries and more
The snapcraft A comprehensive look at the various values that can be defined within a
format snap’s build file
Most of this documentation can be collaboratively discussed and changed on the respective topic in
the doc category of the Snapcraft forum. See the documentation guidelines if you’d like to contribute.
Last updated 3 days ago. Help improve this document in the forum.
he store listing page of your application is an important tool to increase its visibility and discoverability. This
listing is shown in the online Snap Store, the desktop app and in various other graphical store frontends such as
GNOME Software and KDE Discover.
Metadata such as a description and contact information helps users understand what your application
has to offer and helps direct feedback to the right channels.
Media, including screenshots, a video and an icon, show off application functionality, design and brand.
Create a banner to help your application get featured in the store.
For larger projects and ISVs, it might be useful to Create a brand account in the name of the project or
company.
Metadata
A snap’s most important descriptive metadata, initially taken from its snapcraft.yaml, can be conveniently edited
from the Snap Store’s web UI. The following fields are vitally important to help users find what they’re looking for:
ensure the Title is accurate and uses the correct case and spacing
write a 79 character Summary to pitch the application to people browsing the store.
Select up to two store Categories where your application will be featured.
Use Markdown to format the Description to accurately describe the application and highlight it’s most
important features. The following syntax is supported:
o Bold: **Foo**
o URLs: https://foo.bar
o Lists: * Foo
o Italics: _Foo_
o Code: Text indented with 3 spaces or inside `
Use the Additional information section to add a license for your project, and also to select whether you want
users to see where your snap is being used.
Under Website and contact links, include a link to the application website or product page so users can find out
more about related products and services. The Contact link is intended to direct users to somewhere they can
provide feedback about the application. It should point to a support site, forum or bug tracker.
The Snap Advocacy team love accurate and detailed metadata because they can create effective social campaigns
and blog posts to highlight an application. Similarly, it can help to provide a brief functional overview in
the Description and provide links for further detailed documentation.
Media
Second only in importance to the quality of a snap’s metadata is the addition screenshots and other media to
allow prospective users to preview the application.
this icon will only be used in graphical stores frontends, not the desktop menu and dock. Those use
the icon specified in the desktop entry files: Desktop files for menu integration.
Screenshots
Each store entry can feature up to 5 screenshots (or animated GIFs). If the application is cross-platform, please
upload screenshots taken from a Linux workstation rather than reusing screenshots from other platforms. The
images or GIFs need to fit the following requirements:
Screenshot requirements:
image formats: GIF, JPEG & PNG files
min resolution: 480 x 480 pixels
max resolution: 3840 x 2160 pixels
aspect ratio: Between 1:2 and 2:1
file size limit: 2MB
animation min fps: 1
animation max fps: 30
animation max length: 40 seconds