Skip to content

Commit be805e7

Browse files
authored
Merge pull request #258 from lordadamson/patch-1
Updated the readme simplist example.
2 parents a64cfca + 2e4ff40 commit be805e7

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,43 @@ the application uses.
4343

4444
#### Simplest example
4545

46-
Given that a desktop file should be provided with an AppImage, `linuxdeployqt` can use that to determine the parameters of the build.
46+
You'll need to provide the basic structure of an `AppDir` which should look something like this:
47+
```
48+
└── usr
49+
├── bin
50+
│   └── your_app
51+
├── lib
52+
└── share
53+
├── applications
54+
│   └── your_app.desktop
55+
└── icons
56+
└── <theme>
57+
└── <resolution>
58+
└── your_app.png
59+
```
60+
Replace `<theme>` and `<resolution>` with (for example) `hicolor` and `256x256` respectively; see [icon theme spec](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html) for more details.
61+
62+
63+
Using the desktop file `linuxdeployqt` can determine the parameters of the build.
64+
65+
Where your desktop file would look something like:
66+
```
67+
[Desktop Entry]
68+
Version=1.0
69+
Type=Application
70+
Name=Amazing Qt App
71+
Comment=The best Qt Application Ever.
72+
Exec=your_app
73+
Icon=your_app
74+
Categories=Office;
75+
```
76+
77+
* Notice that both `Exec` and `Icon` only have file names.
78+
* Also Notice that the `Icon` entry does not include an extension.
4779

48-
`linuxdeployqt path/to/appdir/usr/share/application_name.desktop`
80+
Read more about desktop files in the [freedesktop specification here](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html).
4981

50-
Where the _desktop_ file specifies the executable to be run (with `EXEC=`), the name of the applications and an icon.
51-
See [desktop file specification](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html).
82+
Now you can say: `linuxdeployqt-continuous-x86_64.AppImage path/to/AppDir/usr/share/applications/your_app.desktop`
5283

5384
For a more detailed example, see "Using linuxdeployqt with Travis CI" below.
5485

0 commit comments

Comments
 (0)