Update documentation - increase Doxygen usage
[geeqie.git] / appimages / README.md
1 # How to create AppImages for Geeqie
2
3 ## Download the required tools:
4
5 Download the `linuxdeploy` tool. At the time of writing, this is:
6 ```sh
7 wget https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage
8 ```
9
10 Move this file to `$HOME/bin` or somewhere else in your `$PATH` and make executable.
11
12 ## Generate the executable
13
14 ```sh
15 cd <your working area>
16 ```
17
18 Download Geeqie sources:
19 ```sh
20 git clone git://www.geeqie.org/geeqie.git
21 cd geeqie
22 ```
23
24 If a run has already been made, remove any existing targets:
25 ```sh
26 rm -r  <target dir>/AppDir
27 sudo rm -rf doc/html
28 ```
29
30 Create a fresh target directory:
31 ```sh
32 mkdir <target dir>/AppDir
33 ```
34
35 Generate the Geeqie executable:
36 ```sh
37 sudo make maintainer-clean
38 ./autogen.sh --prefix="/usr/"
39 make -j
40 make install DESTDIR=<full path to target dir>/AppDir
41 ```
42
43 ## Generate the AppImage
44
45 ```sh
46 cd <target dir>
47 linuxdeploy-x86_64.AppImage \
48     --appdir ./AppDir --output appimage \
49     --desktop-file ./AppDir/usr/share/applications/geeqie.desktop \
50     --icon-file ./AppDir/usr/share/pixmaps/geeqie.png \
51     --executable ./AppDir/usr/bin/geeqie`
52 ```
53
54 ## Rename AppImage
55 If required, rename the AppImage executable - e.g.:
56 ```sh
57 mv ./Geeqie-v1.6-x86_64.AppImage $(./Geeqie-v1.6-x86_64.AppImage -v | sed 's/git//' | sed 's/-.* /-/' | sed 's/ /-v/' | sed 's/-GTK3//').AppImage
58 ```
59
60 ## Automation script
61 The script `./scripts/generate-appimage.sh` automates this process.