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