README.md 2.66 KB
Newer Older
Volker Krause's avatar
Volker Krause committed
1
2
3
4
# KDE Itinerary

Itinerary and boarding pass management application.

5
6
## Using KDE Itinerary

7
8
9
### Are there pre-built packages available?

Yes, but so far only nightly development builds, no stable releases yet.
Volker Krause's avatar
Volker Krause committed
10
11

- Flatpak (for Plasma Mobile/Linux): KDE's Flatpak repository (`flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo`)
12
13
14
15
16
17
18
- Android: KDE's nightly build F-Droid repository

    ![Link to KDE's nightly build F-Droid repository](nightly-build-fdroid-repo-link.png)

    https://cdn.kde.org/android/fdroid/repo/?fingerprint=B3EBE10AFA6C5C400379B34473E843D686C61AE6AD33F423C98AF903F056523F

    or directly on Binary Factory (https://binary-factory.kde.org/view/Android/job/Itinerary_android/).
19

20
21
22
23
24
### Where do I get data from?

- On Android: via the system calendar, if you use DavDroid to sync to a calendar that has
  events with reservation data created by KMail.
- Manually importing Apple Wallet pass or JSON-LD files.
25
- By sending data created by KMail to your phone via KDE Connect
26
27
28
29


## Contributing

30
31
32
33
34
35
### Building for Android, using Docker

An existing docker image exists with everything set up for compilation to Android: kdeorg/android-sdk.
The following command will compile itinerary with all its dependencies and output an apk to our /tmp directory:

```
Nicolas Fella's avatar
Nicolas Fella committed
36
docker run -ti --rm -v /tmp:/output kdeorg/android-sdk /opt/helpers/build-generic itinerary
37
38
39
```

### Building for Android, by hand
Volker Krause's avatar
Volker Krause committed
40

Nicolas Fella's avatar
Nicolas Fella committed
41
42
43
44
45
```
cmake -DQTANDROID_EXPORTED_TARGET=itinerary-app -DANDROID_APK_DIR=<source dir>/src/app  
make  
make install  
make create-apk-itinerary-app  
Volker Krause's avatar
Volker Krause committed
46
47
48
```

Additional CMake options:
Volker Krause's avatar
Volker Krause committed
49

Volker Krause's avatar
Volker Krause committed
50
- BREEZEICONS_DIR: breeze icons source dir (by default assumed next to this folder)
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

If you are using kdesrc-build, the following configuration snippet can be useful to obtain
all external dependencies (on top of the usual KF5 config):
```
module libintl-lite
    repository https://github.com/j-jorge/libintl-lite.git
endmodule

module libical
    repository https://github.com/libical/libical
    branch 2.0
    cmake-options -DICAL_BUILD_DOCS=OFF -DICAL_GLIB=OFF
endmodule

module libqrencode
    repository https://github.com/fukuchi/libqrencode.git
    cmake-options -DWITH_TOOLS=OFF
endmodule

options ki18n
    cmake-options -DBUILD_WITH_QTSCRIPT=OFF
end options

options itinerary
    cmake-options -DQTANDROID_EXPORTED_TARGET=itinerary-app
    make-options create-apk-itinerary-app
end options
```
Edward Betts's avatar
Edward Betts committed
79
You will also need OpenSSL in a version matching what your Qt was built against, which unfortunately
80
81
is a bit more cumbersome to build, see https://wiki.openssl.org/index.php/Android.

Volker Krause's avatar
Volker Krause committed
82
### Building for all other platforms
83
84

Works too of course, just the usual cmake/make/make install.