From 7fdf33913266e2e94850839d32b32e6c975e348f Mon Sep 17 00:00:00 2001 From: Adam Zahran Date: Sat, 17 Mar 2018 15:32:09 +0200 Subject: [PATCH] Updated the readme simplist example. made it a bit more complicated, but at least anyone reading won't have to ask amiright lol --- README.md | 37 +++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2e5edc5..faf2533 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,41 @@ 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 + └── hicolor + └── 256x256 + └── your_app.png +``` + +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 path/to/AppDir/usr/share/applications/your_app.desktop` For a more detailed example, see "Using linuxdeployqt with Travis CI" below.