aboutsummaryrefslogtreecommitdiff
path: root/docs/manual
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/Building.md18
1 files changed, 10 insertions, 8 deletions
diff --git a/docs/manual/Building.md b/docs/manual/Building.md
index a0c6d94..5eee024 100644
--- a/docs/manual/Building.md
+++ b/docs/manual/Building.md
@@ -4,9 +4,8 @@
### Libraries
- [Qt](https://www.qt.io/)
- - at least 5.9 (codebase should largely work with Qt 5.7)
- - core, widgets
- - webengine, webenginewidgets
+ - an up-to-date version, even thought the codebase should largely work with Qt 5.7 or later
+ - WebEngine
- [libconfig](https://hyperrealm.github.io/libconfig/)
### Tools
@@ -17,16 +16,19 @@
- minimal version 3.1.0, but please use something up-to-date
## Compiling
+smolbote follows the generic cmake build template.
```
-cmake -DCMAKE_BUILD_TYPE=Release ../smolbote.git
+# generate makefile
+cmake -DCMAKE_BUILD_TYPE=Release -G "Unix Makefiles" ../smolbote.git
+# build
make -j 4
+# install
+make DESTDIR=/install/root/goes/here install
```
### Using libc++
-```text
-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DUseLibCpp=On ../smolbote.git
-make -j 4
-```
+You can use libc++ over stdlibc++ by setting UseLibCpp to On. Requires clang.
+> -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DUseLibCpp=On
## Packaging