utilities/ktrip/README.md

0001 <!--
0002     SPDX-FileCopyrightText: 2019-2020 Nicolas Fella <nicolas.fella@gmx.de>
0003     SPDX-License-Identifier: CC0-1.0
0004 -->
0005
0006 # Summary
0007 KTrip is a public transport assistant targeted towards mobile Linux and Android.
0008
0009 It allows to query journeys for a wide range of countries/public transport providers by leveraging [KPublicTransport](https://cgit.kde.org/kpublictransport.git/).
0010
0011 <a href='https://flathub.org/apps/details/org.kde.ktrip'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
0012
0013 # Get it
0014
0015 Nightly [Android APKs](https://binary-factory.kde.org/view/Android/job/KTrip_android/) and [Windows installers](https://binary-factory.kde.org/view/Windows%2064-bit/job/KTrip_Nightly_win64/) can be found at KDE's binary factory.
0016
0017 Nightly Flatpak builds are available:
0018
0019 `flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo`
0020
0021 `flatpak install kdeapps org.kde.ktrip`
0022
0023 # Building
0024
0025 KTrip depends on Qt 5 and a number of KDE Frameworks:
0026 - KCoreAddons
0027 - KI18n
0028 - KConfig
0029 - Kirigami
0030 - KPublicTransport
0031 - kirigami-addons
0032
0033 ## Linux
0034
0035 `git clone https://invent.kde.org/utilities/ktrip`
0036
0037 `cd ktrip`
0038
0039 `mkdir build`
0040
0041 `cd build`
0042
0043 `cmake -DCMAKE_INSTALL_PREFIX=/usr ..`
0044
0045 `make`
0046
0047 `sudo make install`
0048
0049 This assumes that all dependencies are installed. If your distribution does not provide them you can use [kdesrc-build](https://kdesrc-build.kde.org/) to build all of them conveniently.
0050
0051 ## Android
0052
0053 You can build KTrip for Android using KDE's [Docker-based build environment](https://community.kde.org/Android/Environment_via_Container).
0054
0055 ## Windows
0056
0057 You can build KTrip on Windows using KDE's [Craft](https://community.kde.org/Craft).
0058
0059 ## macOS and iOS
0060
0061 Running on macOS and iOS should be possible in theory, but is untested. Building on macOS should be possible using KDE's [Craft](https://community.kde.org/Craft). Patches are welcome.