README.md 3.08 KB
Newer Older
LNJ's avatar
LNJ committed
1
# Kaidan - A user-friendly XMPP client for every device!
2

3
[![Kaidan MUC](https://search.jabbercat.org/api/1.0/badge?address=kaidan@muc.kaidan.im)](https://i.kaidan.im)
4
[![Flatpak Build Status](https://binary-factory.kde.org/buildStatus/icon?job=Kaidan_flatpak)](https://binary-factory.kde.org/job/Kaidan_flatpak/)
5
[![Translation](https://hosted.weblate.org/widgets/kaidan/-/svg-badge.svg)](https://hosted.weblate.org/projects/kaidan/translations/)
LNJ's avatar
LNJ committed
6
[![license](https://img.shields.io/badge/License-GPLv3%2B%20%2F%20CC%20BY--SA%204.0-blue.svg)](https://raw.githubusercontent.com/kaidanim/kaidan/master/LICENSE)
7
[![Donations](https://img.shields.io/liberapay/patrons/kaidan.svg?logo=liberapay)](https://liberapay.com/kaidan)
8

9
![Kaidan screenshot](https://www.kaidan.im/images/screenshot.png)
LNJ's avatar
LNJ committed
10 11 12

## About

13 14 15
Kaidan is a simple, user-friendly Jabber/XMPP client providing a modern user
interface using [Kirigami][kg] and [QtQuick][qquick]. The back-end of Kaidan is
written in C++ using the [QXmpp][qxmpp] XMPP client library and [Qt 5][qt].
LNJ's avatar
LNJ committed
16

17 18 19 20 21 22
Kaidan runs on mobile and desktop Linux systems, including Plasma Mobile and
[Ubuntu Touch][openstore]. There are static Windows builds and macOS is also
supported, but we currently can't provide builds for it. The support for the
legacy mobile systems Android and iOS is very experimental and we currently only
provide test builds for [Android][android]. We might support SailfishOS in the
future in case the Sailfish SDK gets an update for Qt.
LNJ's avatar
LNJ committed
23

24 25 26
Kaidan is *not* finished yet, so don't expect it working as well as a finished
client will do -- Many features are still missing, many things still need to be
fixed and improved.
LNJ's avatar
LNJ committed
27

28
For a list of supported XEPs, have a look at the [Wiki][supp-xeps].
29

30
## Installing Kaidan
31

32 33
Instead of building Kaidan yourself, you can also just install ready-made builds. On these pages is explained
how to do that:
34 35
 * [Install the Flatpak](https://invent.kde.org/kde/kaidan/wikis/install/flatpak)
 * [Install from OpenStore (Ubuntu Touch)][openstore]
36

37
## Building Kaidan
38

39
### Dependencies
40

41 42
Here are the general dependencies of Kaidan listed:
 * [Qt](https://doc.qt.io/qt-5/build-sources.html) (Core Qml Quick Svg Sql QuickControls2) (>= 5.8.0)
43
 * [QXmpp][qxmpp] (>= 0.9.0)
44
 * [Kirigami 2](https://phabricator.kde.org/source/kirigami/) (>= 5.42.0)
45
 * [ECM (extra-cmake-modules)](https://api.kde.org/ecm/manual/ecm.7.html)
46
 * [KNotifications][knotif] (`-DUSE_KNOTIFICATIONS=OFF` to disable)
47

48
### Build instructions
49

50
There are guides on how to build Kaidan for each supported platform (currently there are still pages missing):
LNJ's avatar
LNJ committed
51 52
 * [Linux Desktop](https://invent.kde.org/kde/kaidan/wikis/building/linux-debian-based)
 * [Ubuntu Touch (click package)](https://invent.kde.org/kde/kaidan/wikis/building/ubuntu-touch)
53 54 55 56 57 58 59 60 61


[kg]: https://kde.org/products/kirigami/
[qquick]: https://wiki.qt.io/Qt_Quick
[qxmpp]: http://qxmpp.org
[qt]: https://www.qt.io/
[openstore]: https://open-store.io/app/im.kaidan.kaidan
[android]: https://www.kaidan.im/download/#android
[supp-xeps]: https://invent.kde.org/kde/kaidan/wikis/Supported-XEPs
62
[knotif]: https://api.kde.org/frameworks/knotifications/html/index.html