aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..19b6373
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,31 @@
+# Build and installation instructions
+
+## For end-users and packagers
+
+```
+mkdir build
+cd build
+cmake ..
+make
+sudo make install
+```
+## For testers - unit tests only
+
+```
+mkdir build
+cd build
+cmake .. -DENABLE_TESTS=ON
+make
+make test
+```
+## For testers - both unit tests and code coverage
+
+```
+mkdir build
+cd build
+cmake .. -DENABLE_COVERAGE=ON
+make
+make test
+make coverage
+```
+**The install prefix defaults to `/usr`, change it with `-DCMAKE_INSTALL_PREFIX=/some/path`**