README.md 3.22 KB
Newer Older
Linus Jahn's avatar
Linus Jahn 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/)
Linus Jahn's avatar
Linus Jahn 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)
Linus Jahn's avatar
Linus Jahn committed
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)
Linus Jahn's avatar
Linus Jahn committed
10 11 12

## About

13 14 15 16 17
[Kaidan][kaidan-website] is a simple, user-friendly and modern chat client. It
uses the open communication protocol [XMPP (Jabber)][xmpp]. The user interface
makes use of [Kirigami][kirigami-website] and [QtQuick][qtquick], while the
back-end of Kaidan is entirely written in C++ using [Qt][qt] and the Qt-based
XMPP library [QXmpp][qxmpp].
Linus Jahn's avatar
Linus Jahn committed
18

19 20 21 22
Kaidan runs on mobile and desktop systems including Linux, Windows, macOS,
Android, Plasma Mobile and Ubuntu Touch.
Unfortunately, we are not able to provide builds for all platforms atthe moment
due to little developer resources.
Linus Jahn's avatar
Linus Jahn committed
23

24 25 26
Kaidan does *not* have all basic features yet and has still some stability
issues. Do not expect it to be as good as the currently dominating instant
messaging clients.
Linus Jahn's avatar
Linus Jahn committed
27

28 29
If you are interested in the technical features Kaidan supports, you can have a
look at our [overview of XEPs and RFCs][xeps-rfcs].
30

31
## Using and Building Kaidan
32

33 34 35
Downloadable builds are available on [Kaidan's download page][downloads].
Instructions for using ready-made (nightly / stable) builds and for building
Kaidan yourself can be found in our [Wiki][wiki].
36

37
## Dependencies
38

39 40
Here are the general dependencies of Kaidan:
 * [Qt][qt-build-sources] (Core Qml Quick Svg Sql QuickControls2 Xml Multimedia Positioning Location) (>= 5.12.0)
Linus Jahn's avatar
Linus Jahn committed
41
 * [QXmpp][qxmpp] (>= 1.2.0)
42 43 44 45
 * [Kirigami 2][kirigami-repo] (>= 5.58.0)
 * [ECM (extra-cmake-modules)][ecm]
 * [ZXing-cpp][zxing-cpp]
 * [KNotifications][knotifications] (`-DUSE_KNOTIFICATIONS=OFF` to disable)
46

Melvin Keskin's avatar
Melvin Keskin committed
47 48
## Contributing

49 50 51 52 53 54 55 56 57 58 59
If you are interested in contributing to Kaidan, please have a look at our
[contribution guidelines][CONTRIBUTING.md]. If you want to improve Kaidan's
website, feel free to visit its [project site][kaidan-website-repo].

[downloads]: https://www.kaidan.im/download/
[ecm]: https://api.kde.org/ecm/manual/ecm.7.html
[kaidan-website]: https://kaidan.im
[kaidan-website-repo]: https://invent.kde.org/websites/kaidan-im
[kirigami-repo]: https://invent.kde.org/frameworks/kirigami
[kirigami-website]: https://kde.org/products/kirigami/
[knotifications]: https://api.kde.org/frameworks/knotifications/html/index.html
60
[qt]: https://www.qt.io/
61 62 63 64 65 66 67
[qt-build-sources]: https://doc.qt.io/qt-5/build-sources.html
[qtquick]: https://wiki.qt.io/Qt_Quick
[qxmpp]: https://github.com/qxmpp-project/qxmpp
[wiki]: https://invent.kde.org/network/kaidan/-/wikis/home
[xeps-rfcs]: https://invent.kde.org/network/kaidan/-/wikis/xeps-rfcs
[xmpp]: https://xmpp.org
[zxing-cpp]: https://github.com/nu-book/zxing-cpp