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

3
[![Flatpak Build Status](https://binary-factory.kde.org/buildStatus/icon?job=Kaidan_flatpak)](https://binary-factory.kde.org/job/Kaidan_flatpak/)
4
[![Translation](https://hosted.weblate.org/widgets/kaidan/-/svg-badge.svg)](https://hosted.weblate.org/projects/kaidan/translations/)
5
[![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)
6
[![Donations](https://img.shields.io/liberapay/patrons/kaidan.svg?logo=liberapay)](https://liberapay.com/kaidan)
7

8
![Kaidan v0.3 screenshot](https://git.kaidan.im/kaidan/kaidan/uploads/da4886ea50581517bde0278a804b311c/kaidan-screenshot-0.3.png)
9 10 11

## About

12
Kaidan is a simple, user-friendly Jabber/XMPP client providing a modern user-interface using
13
[Kirigami](https://techbase.kde.org/Kirigami) and [QtQuick](https://wiki.qt.io/Qt_Quick). The back-end of
14
Kaidan is entirely written in C++ using the [qxmpp](https://github.com/qxmpp-project/qxmpp) XMPP client library and
15
[Qt 5](https://www.qt.io/).
16

17 18 19 20 21 22
Currently Kaidan only has been tested on GNU/Linux Desktops, Android & Plasma Mobile, but of course
Ubuntu Touch, OS X, iOS and Windows will follow. Of course this is still not everything, i.e. Sailfish OS
is missing. To support that we need to wait for a proper QtQuickControls 2 style for it or rewrite the GUI
using Silica. Both options are rather unlikely in the near future, so if you want to get a client for
Sailfish OS _now_, maybe take a look at [Shmoose](https://github.com/geobra/harbour-shmoose), a fork by an
earlier developer of Kaidan.
23

Linus Jahn's avatar
Linus Jahn committed
24
Kaidan is *not* finished yet, so don't expect it working as well as a finished client will do.
25

26
For a list of supported XEPs, have a look at the [Wiki](https://git.kaidan.im/kaidan/kaidan/wikis/Supported-XEPs).
27

28
## Installing Kaidan
29

30 31 32
Instead of building Kaidan yourself, you can also just install ready-made builds. On these pages is explained
how to do that:
 * [Install the Flatpak](https://git.kaidan.im/kaidan/kaidan/wikis/install/flatpak)
33

34
## Building Kaidan
35

36
### Dependencies
37

38 39
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)
40
 * [qxmpp](https://github.com/qxmpp-project/qxmpp) (>= 0.9.0)
41
 * [Kirigami 2](https://phabricator.kde.org/source/kirigami/) (>= 5.42.0)
42
 * [ECM (extra-cmake-modules)](https://api.kde.org/ecm/manual/ecm.7.html)
43

44
### Build instructions
45

46 47 48
There are guides on how to build Kaidan for each supported platform (currently there are still pages missing):
 * [Linux Desktop](https://git.kaidan.im/kaidan/kaidan/wikis/building/linux-debian-based)
 * [Ubuntu Touch (click package)](https://git.kaidan.im/kaidan/kaidan/wikis/building/ubuntu-touch)