Browse Source

Merge pull request #258 from lordadamson/patch-1

Updated the readme simplist example.
master
TheAssassin 7 years ago
committed by GitHub
parent
commit
be805e7df2
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 39
      README.md

39
README.md

@ -43,12 +43,43 @@ the application uses.
#### Simplest example
Given that a desktop file should be provided with an AppImage, `linuxdeployqt` can use that to determine the parameters of the build.
You'll need to provide the basic structure of an `AppDir` which should look something like this:
```
└── usr
├── bin
│   └── your_app
├── lib
└── share
├── applications
│   └── your_app.desktop
└── icons
└── <theme>
└── <resolution>
└── your_app.png
```
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.
Using the desktop file `linuxdeployqt` can determine the parameters of the build.
Where your desktop file would look something like:
```
[Desktop Entry]
Version=1.0
Type=Application
Name=Amazing Qt App
Comment=The best Qt Application Ever.
Exec=your_app
Icon=your_app
Categories=Office;
```
* Notice that both `Exec` and `Icon` only have file names.
* Also Notice that the `Icon` entry does not include an extension.
`linuxdeployqt path/to/appdir/usr/share/application_name.desktop`
Read more about desktop files in the [freedesktop specification here](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html).
Where the _desktop_ file specifies the executable to be run (with `EXEC=`), the name of the applications and an icon.
See [desktop file specification](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html).
Now you can say: `linuxdeployqt-continuous-x86_64.AppImage path/to/AppDir/usr/share/applications/your_app.desktop`
For a more detailed example, see "Using linuxdeployqt with Travis CI" below.

Loading…
Cancel
Save