From 17f5d8f5023f496cb09b2800786af1a43aabf247 Mon Sep 17 00:00:00 2001
From: Robert Tari <robert@tari.in>
Date: Thu, 29 Apr 2021 18:59:04 +0200
Subject: INSTALL.md: Add build/installation instructions

---
 INSTALL.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 INSTALL.md

(limited to 'INSTALL.md')

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`**
-- 
cgit v1.2.3