add readme

This commit is contained in:
Jussi Kuokkanen 2020-04-04 20:58:09 +03:00
parent 88ccc075ca
commit 9410102c89

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# Installation
## Dependencies
boost-system, boost-filesystem, qtdbus
## Meson options
```
--prefix=<path> (install location prefix, usually '/usr')
-Dplugins=<true/false>
-Ddaemon=<true/false> (builds and installs 'tuxclockerd' binary/daemon)
```
```
git clone https://github.com/Lurkki14/tuxclocker
cd tuxclocker
git checkout cpplib
git submodule init
git submodule update
meson build <meson options>
cd build
ninja && sudo ninja install
```