aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/Building.Compiling.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2017-09-22 16:44:19 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2017-09-22 16:44:19 +0200
commitf0551b8645d9e3babf35e40fbc74c02ec8990e58 (patch)
tree140ce0b81f1da4a385a02709e03e9a734c0ee420 /docs/manual/Building.Compiling.md
parentFixed bug with starting up if the local socket wasn't cleaned up (diff)
downloadsmolbote-f0551b8645d9e3babf35e40fbc74c02ec8990e58.tar.xz
Updated documentation
Diffstat (limited to 'docs/manual/Building.Compiling.md')
-rw-r--r--docs/manual/Building.Compiling.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/manual/Building.Compiling.md b/docs/manual/Building.Compiling.md
new file mode 100644
index 0000000..bf6637e
--- /dev/null
+++ b/docs/manual/Building.Compiling.md
@@ -0,0 +1,44 @@
+# Compiling
+
+## Creating qbs configuration
+Before you can build anything with qbs, you need to set up the compiler
+toolchain as well as Qt.
+
+```
+qbs setup-toolchains --detect
+qbs setup-qt /usr/bin/qmake-qt5 qt5
+```
+
+
+## Compiling
+
+* Create a build folder
+```
+[smolbote repo]$ mkdir ../build
+```
+
+* Run qbs
+```
+[smolbote repo]$ qbs build -d ../build profile:qt5 release
+```
+This installs the files to ../build/release/install-root.
+
+* Run
+```
+[smolbote repo]$ qbs run -d ../build -p poi profile:qt5 release
+```
+
+## mach
+mach is a helper script that can build and run smolbote.
+
+#### setup
+./mach setup creates a qbs configuration in :settingsDir,
+by default ../build/config.
+
+You can edit this using qbs-config-ui --settings-dir ../build/config.
+
+#### run
+
+#### clean
+
+#### build