Commit 9b8a7942 authored by Linus Jahn's avatar Linus Jahn

README: Replace build instructions with links to Wiki

parent 596f9e88
Pipeline #3204 passed with stage
in 5 minutes
......@@ -25,120 +25,24 @@ Kaidan is *not* finished yet, so don't expect it working as well as a finished c
For a list of supported XEPs, have a look at the [Wiki](https://git.kaidan.im/kaidan/kaidan/wikis/Supported-XEPs).
## Compilation & Installation
## Installing Kaidan
* [Debian sid based systems](#debian-sid-based-systems)
* [Linux Desktop](#compile-kaidan-for-desktop-linux)
* [Ubuntu Touch (click package)](#compile-kaidan-for-ubuntu-touch)
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)
## Building Kaidan
### Flatpak capable systems (most recent Linux distributions)
### Dependencies
Kaidan flatpak builds are kindly provided by KDE. Add their repository to your system
```
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo
```
You can now install kaidan
```
flatpak install kdeapps im.kaidan.kaidan
```
### Debian sid based systems
Add our APT repository to your system
```
sudo echo "deb https://www.kaidan.im/packages sid main" > /etc/apt/sources.list.d/kaidan.list
wget https://www.kaidan.im/packages/pub.asc -qO - | sudo apt-key add -
sudo apt update
```
Then you can install Kaidan
```bash
sudo apt install kaidan
```
### Compile Kaidan for Desktop Linux
#### Install all dependencies:
* [Qt](https://doc.qt.io/qt-5/build-sources.html) (Core Qml Quick Sql QuickControls2) (>= 5.8.0)
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)
* [gloox](https://camaya.net/gloox/download/) (>= 1.0.19)
* [Kirigami 2](https://phabricator.kde.org/source/kirigami/) (>= 5.42.0)
* [ECM (extra-cmake-modules)](https://api.kde.org/ecm/manual/ecm.7.html)
Build only dependencies:
* A C++ compiler
* Qt Tools
* CMake
* Git (if you don't want to use tarballs/zips from github)
##### On Ubuntu *18.04+*, KDE Neon 16.04 or debian *sid* do the following:
Debian strech and older Ubuntu distros are not supported since they don't provide Qt 5.8 or newer.
```bash
sudo apt install apt-transport-https git-core cmake build-essential zlib1g-dev \
libgloox-dev libnotify-bin libqt5quick5 libqt5quickcontrols2-5 libqt5quickwidgets5 \
libqt5qml5 libqt5gui5 libqt5core5a qtdeclarative5-dev qttools5-dev qt5-default \
qtquickcontrols2-5-dev kirigami2-dev extra-cmake-modules libqt5svg5-dev \
qml-module-qt-labs-platform
```
#### Get the source code:
```bash
git clone https://git.kaidan.im/kaidan/kaidan
```
#### Compile it:
```bash
mkdir kaidan/build ; cd kaidan/build
cmake .. -DI18N=1
make -j$(nproc)
```
#### Now you can run Kaidan:
```bash
./bin/kaidan
```
#### If you like it, install it by:
```bash
sudo make install
```
### Compile Kaidan for Ubuntu Touch
This will fully automatically compile and build a click packge for Ubuntu Touch 16.04. Clickable and our
build script do the hard work for you, so building is rather simple.
Build-dependencies:
* [Clickable](https://github.com/bhdouglass/clickable)
* [Docker](https://www.docker.com/)
* Git
#### Set up clickable docker container
After you've installed the dependencies, you need to set up the Ubuntu Touch SDK docker container.
```bash
clickable setup-docker
```
#### Clone Kaidan and start build
Now, you can clone our Kaidan repository using git and start building kaidan using clickable.
```bash
git clone --recursive https://git.kaidan.im/kaidan/kaidan
cd kaidan
clickable clean build click-build
```
### Build instructions
The built click package will be located at `bin/ubuntu-touch/`.
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)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment