Commit ef25068d authored by Linus Jahn's avatar Linus Jahn Committed by GitHub

REAME: Improve design and compilation/installation guide (#115)

parent 5bf3155f
......@@ -29,51 +29,70 @@ Kaidan is *not* finished yet, so don't expect it working as well as a finished c
## Installation
### Debian Sid based systems
Note: We can not guarantee that the packages available from the repository are always up to date.
### Debian Stretch based systems
Add our apt repository to your system
* `sudo apt-get install apt-transport-https software-properties-common dirmngr`
* `sudo apt-add-repository "deb https://raw.githubusercontent.com/kaidanim/packages/master sid main"`
* `sudo apt-key adv --keyserver hkp://pgp.mit.edu --recv-key "210EB0BCA70439F0"`
* `sudo apt-get update`
```
sudo apt-get install apt-transport-https software-properties-common dirmngr gnupg
sudo apt-add-repository "deb https://raw.githubusercontent.com/kaidanim/packages/master stretch main"
sudo apt-key adv --keyserver hkp://pgp.mit.edu --recv-key "210EB0BCA70439F0"
sudo apt-get update
```
Then install Kaidan
* `sudo apt-get install kaidan`
`sudo apt-get install kaidan`
### Compile it yourself
On Linux do the following:
Install dependencies to build Kaidan (for Debian Stretch and Sid)
* `sudo apt-get install apt-transport-https git-core cmake build-essential zlib1g-dev libglib2.0-dev libssl-dev libxml2-dev libcrypto++-dev libpthread-stubs0-dev libidn11-dev libminiupnpc-dev libnatpmp-dev libswiften-dev libboost-system-dev libnotify-bin libboost-program-options-dev libboost-serialization-dev libqt5quick5 libqt5quickcontrols2-5 libqt5quickwidgets5 libqt5qml5 libqt5gui5 libqt5core5a qtdeclarative5-dev qttools5-dev qt5-default qtquickcontrols2-5-dev qml-module-qtquick-controls2`
Debian currently has no Kirigami2 packages, so we have to install them from external sources.
* `sudo apt-add-repository "deb https://raw.githubusercontent.com/kaidanim/packages/master sid main"`
* `sudo apt-key adv --keyserver hkp://pgp.mit.edu --recv-key "210EB0BCA70439F0"`
* `sudo apt-get update`
* `sudo apt-get install kirigami2-dev`
Get Kaidan source code
* `git clone https://github.com/kaidanim/kaidan`
Finally compile it
* `mkdir kaidan/build ; cd kaidan/build`
* `cmake .. -DI18N=1`
* `make -j$(nproc)`
Now you can run Kaidan:
* `./kaidan`
If you like it, install it by:
#### Install all dependencies:
* Qt (Core Qml Quick Sql QuickControls2) (>= 5.7.0)
* Swiften (>= 3.0.0)
* Boost (>= 1.34.1)
* Kirigami 2 (>= 2.0.0)
Build only dependencies:
* A C++ compiler
* Qt Tools
* CMake
* Git (if you don't want to use tarballs/zips from github)
##### On Debian Stretch or Sid do the following:
```bash
sudo apt-get install apt-transport-https git-core cmake build-essential zlib1g-dev \
libglib2.0-dev libssl-dev libxml2-dev libcrypto++-dev libpthread-stubs0-dev libidn11-dev \
libminiupnpc-dev libnatpmp-dev libboost-system-dev libnotify-bin \
libboost-program-options-dev libboost-serialization-dev libqt5quick5 libqt5quickcontrols2-5 \
libqt5quickwidgets5 libqt5qml5 libqt5gui5 libqt5core5a qtdeclarative5-dev qttools5-dev \
qt5-default qtquickcontrols2-5-dev qml-module-qtquick-controls2
```
Debian currently has no Kirigami2 packages, so we have to install them from external sources:
```bash
sudo apt-add-repository "deb https://raw.githubusercontent.com/kaidanim/packages/master sid main"
sudo apt-key adv --keyserver hkp://pgp.mit.edu --recv-key "210EB0BCA70439F0"
sudo apt-get update
sudo apt-get install kirigami2-dev libswiften-dev
```
#### Get the source code:
`git clone https://github.com/kaidanim/kaidan`
#### Finally compile it:
```bash
mkdir kaidan/build ; cd kaidan/build
cmake .. -DI18N=1
make -j$(nproc)
```
#### Now you can run Kaidan:
`./kaidan`
#### If you like it, install it by:
* `sudo make install`
......
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