Skip to content

Commit 2b8f5b3

Browse files
authored
Update README.md
[ci skip]
1 parent e8dadbb commit 2b8f5b3

File tree

1 file changed

+11
-62
lines changed

1 file changed

+11
-62
lines changed

README.md

Lines changed: 11 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# AppImageKit ![Downloads](https://img.shields.io/github/downloads/AppImage/AppImageKit/total.svg) [![irc](https://img.shields.io/badge/IRC-%23AppImage%20on%20libera.chat-blue.svg)](https://web.libera.chat/#AppImage) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZT9CL8M5TJU72)
1+
# AppImageKit [![irc](https://img.shields.io/badge/IRC-%23AppImage%20on%20libera.chat-blue.svg)](https://web.libera.chat/#AppImage) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZT9CL8M5TJU72)
22

33
The __AppImage__ format is a format for packaging applications in a way that allows them to
44
run on a variety of different target systems (base operating systems, distributions) without further modification.
55

66
Using the AppImage format you can package desktop applications as AppImages that run on common Linux-based operating systems, such as RHEL, CentOS, Ubuntu, Fedora, Debian and derivatives.
77

8-
Copyright (c) 2004-22 Simon Peter <[email protected]> and contributors.
8+
Copyright (c) 2004-24 Simon Peter <[email protected]> and contributors.
99

1010
https://en.wikipedia.org/wiki/AppImage
1111

@@ -127,68 +127,17 @@ Leafpad-0.8.18.1.glibc2.4-x86_64.AppImage.config/leafpad/leafpadrc
127127

128128
Note that the file `leafpadrc` was written in the directory we have created before.
129129

130-
## appimagetool usage
130+
## appimagetool
131131

132-
`appimagetool` is used to generate an AppImage from an existing `AppDir`. Higher-level tools such as [`linuxdeployqt`](https://github.com/probonopd/linuxdeployqt) use it internally. A precompiled version can be found on [GitHub Releases](https://github.com/AppImage/AppImageKit/releases).
132+
`appimagetool` is a low-level tool used to convert a valid AppDir into an AppImage. It us usually used by [higher-level tools](https://github.com/AppImageCommunity/awesome-appimage?tab=readme-ov-file#appimage-developer-tools) that can be used by application developers to provide AppImages of their applications to end users. `appimagetool` itself is not needed by end users, and is normally not used directly by developers.
133+
Please see https://github.com/AppImage/appimagetool.
133134

134-
```
135-
wget "https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage"
136-
chmod a+x appimagetool-x86_64.AppImage
137-
```
138-
139-
Usage in a nutshell, assuming that you already have an [AppDir](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#appdir) in place:
140-
141-
```
142-
./appimagetool-x86_64.AppImage some.AppDir
143-
```
144-
145-
Detailed usage:
146-
```
147-
Usage:
148-
appimagetool [OPTION...] SOURCE [DESTINATION] - Generate, extract, and inspect AppImages
149-
150-
Help Options:
151-
-h, --help Show help options
152-
153-
Application Options:
154-
-l, --list List files in SOURCE AppImage
155-
-u, --updateinformation Embed update information STRING; if zsyncmake is installed, generate zsync file
156-
-g, --guess Guess update information based on Travis CI or GitLab environment variables
157-
--bintray-user Bintray user name
158-
--bintray-repo Bintray repository
159-
--version Show version number
160-
-v, --verbose Produce verbose output
161-
-s, --sign Sign with gpg[2]
162-
--comp Squashfs compression
163-
-n, --no-appstream Do not check AppStream metadata
164-
--exclude-file Uses given file as exclude file for mksquashfs, in addition to .appimageignore.
165-
--runtime-file Runtime file to use
166-
--sign-key Key ID to use for gpg[2] signatures
167-
--sign-args Extra arguments to use when signing with gpg[2]
168-
```
169-
170-
If you want to generate an AppImage manually, you can:
135+
## AppImage runtime
171136

172-
```
173-
mksquashfs Your.AppDir Your.squashfs -root-owned -noappend
174-
cat runtime >> Your.AppImage
175-
cat Your.squashfs >> Your.AppImage
176-
chmod a+x Your.AppImage
177-
```
178-
179-
180-
## Building
181-
182-
__NOTE:__ The AppImage project supplies [binaries](https://github.com/AppImage/AppImageKit/releases/tag/continuous) that application developers can use. These binaries are built using the CentOS 6 Docker on Travis CI build system in this repository. As an application developer, you do not have to use the build system. You only have to use the build systems when contributing to AppImageKit, when needing another architecture than `x86_64`, or when trying to reproduce our binaries.
183-
184-
Our build system is based on Docker. To build your own binaries, please install Docker first. Then, follow the following steps:
185-
186-
```
187-
git clone --single-branch --recursive https://github.com/AppImage/AppImageKit
188-
cd AppImageKit/
189-
bash ci/build.sh
190-
```
137+
The AppImage runtime is a small piece of code that becomes part of every AppImage. It mounts the AppImage and executes the application contained in it.
138+
Please see https://github.com/AppImage/type2-runtime.
191139

192-
This will create the binaries in a directory called `out/`.
140+
## AppImageSpec
193141

194-
Please note: It is not recommended nor supported to build AppImageKit on any newer build system than the oldest still-supported versions of major distributions for reasons outlined [here](https://github.com/AppImage/AppImageKit/wiki/Creating-AppImages#creating-appimages-that-are-compatible-with-many-systems). Currently we are targeting CentOS 6.x and Ubuntu 14.04 as build systems and we are not interested to build AppImageKit on newer versions anytime soon. Binaries built on those systems will run just fine on newer (later) target systems (distributions).
142+
The AppImageSpec defines the AppImage format.
143+
Please see https://github.com/AppImage/AppImageSpec.

0 commit comments

Comments
 (0)