|
4 | 4 |
|
5 | 5 | <p> GTK user interface for <a href="https://github.com/AppImage/appimagekit">appimagekit</a></p> |
6 | 6 |
|
7 | | - <h2> Usage </h2> |
| 7 | + <h1> Documentation </h1> |
8 | 8 |
|
9 | | - <h4>For now it only supports one file scripts/apps</h4> |
| 9 | + See the <a href="https://appimage-builder.readthedocs.io/en/latest/">appimage builder</a> docs for all the info about AppImages |
10 | 10 |
|
11 | | - <h3>Types/Categories</h3> |
12 | | - You can see <a href="https://specifications.freedesktop.org/menu-spec/latest/apa.html">valid types and categories</a> in the official documentation page |
13 | | - |
14 | | - <h3>App generated .AppDir</h3> |
15 | | - The .AppDir folder contains:<br><br> |
| 11 | + <h2> Appimages </h2> |
| 12 | + |
| 13 | + <h3>App generated .AppDir</h3> |
| 14 | + <b>This is without any option activated so result may vary</b><br> |
| 15 | + The .AppDir folder contains:<br><br> |
16 | 16 | <ul> |
17 | 17 | <li>the bin folder where the executable file/script/app is</li> |
18 | | - <li>.deskop file |
19 | | - <details> |
20 | | - <summary>content</summary> |
21 | | - <div> |
| 18 | + <li> <a href=#.Desktop>Desktop file</a></li> |
| 19 | + <li> <a href=#Icon>Icon</a></li> |
| 20 | + <li> <a href=#AppRun>AppRun</a></li> |
| 21 | +</ul> |
| 22 | + |
| 23 | +<div id=".Desktop"> |
| 24 | + <h2>Desktop file</h2> |
| 25 | +The app creates a Desktop entry for you automatically when building the .AppDir folder. To see the content click... |
| 26 | +<details> |
| 27 | + <summary>...here</summary><div> |
22 | 28 |
|
23 | 29 | [Desktop Entry] |
24 | 30 | Name=Flake |
25 | 31 | Exec=Flake-v0.0.1-x86_64.AppImage (which is picked from the /usr/bin folder inside the .AppImage) |
26 | 32 | Icon=Icon.svg |
27 | 33 | Type=Application |
28 | 34 | Categories=Utility |
29 | | -</div></details></li> |
30 | | - <li>icon</li> |
31 | | - <li>AppRun |
32 | | - <details> |
33 | | - <summary>Auto generated .AppRun</summary> |
34 | | - <div> |
35 | | - |
36 | | - #!/bin/sh |
37 | | - HERE="$(dirname "$(readlink -f "${0}")")" |
38 | | - EXEC="${HERE}/usr/bin/[selected exe]" |
39 | | - exec "${EXEC}" |
40 | 35 |
|
41 | | - </div> |
42 | | - |
43 | | -</details></li> |
44 | | -</ul> |
45 | | - |
| 36 | +</div></details></li> |
| 37 | + </div> |
46 | 38 |
|
47 | | - <h2> Documentation </h2> |
48 | | - |
49 | | - Flake provides a gtk user friendly interface for <a href="https://github.com/AppImage/appimagekit">appimagetool</a>, that has a terminal only interface |
50 | 39 |
|
51 | | - This first version has only the very basic options, such as name, icon, executable etc... In the next versions i'll add all the options that appimagetool has and more! |
| 40 | +<div id="Icon"> |
| 41 | + <h2>Icon</h2> |
| 42 | + <p>The icon is used in thumbnails, and should be in a standard size like 128x128 or 256x256 pixels.</p> |
| 43 | +</div> |
52 | 44 |
|
53 | | - See the <a href="https://appimage-builder.readthedocs.io/en/latest/">appimage builder</a> docs |
| 45 | +<div id="AppRun"> |
| 46 | + <h2>AppRun</h2> |
| 47 | + <li><h3>Default AppRun</h3> |
| 48 | + <h4>Only supports one file scripts/application. </h4> |
54 | 49 |
|
55 | | - <h4> Appimages </h4> |
56 | | - |
57 | | - <h5>Only supports one file scripts/application. </h5> |
58 | | - |
59 | | - <p>The app builds the appimages with a default .AppRun file, that works by using the exec command to run the executable file selected, therefore you cannot run any script that is not executable by your terminal or that has specified the script executor (#!/bin/python3 - #!/bin/sh) |
60 | | - |
61 | | -<details> |
62 | | - <summary>default .apprun</summary> |
| 50 | + <p>The app creates a default AppRun file in case a custom one is not provided, if you want to see what's inside... |
| 51 | + <details><summary>...click me</summary> |
63 | 52 | <div> |
64 | 53 |
|
65 | 54 | #!/bin/sh |
66 | 55 | HERE="$(dirname "$(readlink -f "${0}")")" |
67 | 56 | EXEC="${HERE}/usr/bin/[selected exe]" |
68 | 57 | exec "${EXEC}" |
69 | 58 |
|
70 | | - </div> |
71 | | - |
72 | | -</details> |
| 59 | + </div></details> |
| 60 | + |
| 61 | + <li><h3>Custom AppRun</h3> |
| 62 | + <p>The app supports AppRun files made by you, to use this option enable advanced options and enable "custom apprun".<p> |
| 63 | + The official docs on how to setup an AppDir folder are <a href="https://docs.appimage.org/reference/appdir.html">here</a> |
| 64 | + |
| 65 | +</div> |
0 commit comments