Skip to content
This repository holds the specification for the AppImage format.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Add reference-style anchor links and TOC Jun 29, 2016
LICENSE Update LICENSE Jun 15, 2016
README.md Make location of currently used spec more obvious to casual reader. Dec 3, 2017
draft.md 256x256 PNG file Jun 21, 2019

README.md

AppImage Specification README


For direct access to the current specification in writing please go to draft.md.


This repository holds the specification for the AppImage format. The objectives of this specification are to:

  1. Be a single, definitive source of information about the AppImage format
  2. Ensure AppImages behave in a consistent manner, thereby enabling third-party developers to write AppImage management applications and distributions to offer built-in support for AppImages
  3. Serve as a guide for AppImageKit development
  4. Provide developers with a checklist for creating AppImages
  5. Enable a lintian-style application to be written to check AppImages for compliance with the standard (start here)
  6. Indicate the direction of the project and warn developers of future changes to the AppImage format
  7. Document the open nature of the AppImage format

AppImageKit is becoming a reference implementation of building standards-compliant AppImages, and the AppImages repository provides examples.

Contributing

  • Proposals are discussed via GitHub Issues
  • Pull request can be sent for final approval by the maintainer, currently @probonopd
  • The specification is to be kept as concise as possible and will not include any kind of explanation, justification or help with implementation (although it may link to that information)
  • The specification itself will only include the "what", and not the "why" or "how"
  • Detailed justifications and explanation can be preserved by linking to the discussion in the actual pull request
  • General help on creating AppImages is not part of this specification but can be found in the AppImageKit wiki

Organization of this repository

File Purpose
README.md Instructions for contributing
LICENSE Copyright and license
draft.md Working document with proposed changes for the next specification release
versions/ Directory for released versions of the specification
versions/v1.0.md Version 1.0 of the specification
versions/v2.0.md ...
You can’t perform that action at this time.