https://github.com/appimage/appimagespec
This repository holds the specification for the AppImage format.
https://github.com/appimage/appimagespec
appimage appimage-format
Last synced: about 1 year ago
JSON representation
This repository holds the specification for the AppImage format.
- Host: GitHub
- URL: https://github.com/appimage/appimagespec
- Owner: AppImage
- License: mit
- Created: 2016-06-15T15:12:44.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T07:43:56.000Z (over 1 year ago)
- Last Synced: 2025-01-11T01:12:15.360Z (about 1 year ago)
- Topics: appimage, appimage-format
- Homepage: http://appimage.org/
- Size: 74.2 KB
- Stars: 72
- Watchers: 12
- Forks: 23
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AppImage Specification README
----
*For direct access to the current specification in writing please go to [draft.md](https://github.com/AppImage/AppImageSpec/blob/master/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](https://github.com/probonopd/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](https://github.com/probonopd/AppImages/blob/master/appdir-lint.sh))
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](https://github.com/probonopd/AppImageKit) is becoming a reference implementation of building standards-compliant AppImages, and the [AppImages](https://github.com/probonopd/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](https://github.com/probonopd/AppImageKit/wiki)
## Organization of this repository
File | Purpose
---|---
[README.md](README.md) | Instructions for contributing
[LICENSE](LICENSE) | Copyright and license
[draft.md](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 | ...