From 2bf38e75d4feea56e3875bfaef045cc40bbff0f8 Mon Sep 17 00:00:00 2001
From: Robert Tari <robert@tari.in>
Date: Mon, 16 Aug 2021 00:20:19 +0200
Subject: Add info and install instructions

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

(limited to 'INSTALL.md')

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..b522ea3
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,53 @@
+# Build and installation instructions
+
+## Compile-time build dependencies
+
+ - cmake (>= 3.13)
+ - cmake-extras
+ - intltool
+ - libayatana-common (>=0.9.3)
+ - glib-2.0 (>= 2.36)
+ - gudev-1.0
+ - gtest (>= 1.6.0) - **For testing**
+ - qt5-base5 - **For testing**
+ - libqtdbusmock1 - **For testing**
+ - libqtdbustest1 - **For testing**
+ - cppcheck - **For testing**
+ - gcovr (>= 2.4) - **For coverage**
+ - lcov (>= 1.9) - **For coverage**
+
+## For end-users and packagers
+
+```
+cd ayatana-indicator-display-X.Y.Z
+mkdir build
+cd build
+cmake ..
+make
+sudo make install
+```
+
+**The install prefix defaults to `/usr`, change it with `-DCMAKE_INSTALL_PREFIX=/some/path`**
+
+## For testers - unit tests only
+
+```
+cd ayatana-indicator-display-X.Y.Z
+mkdir build
+cd build
+cmake .. -DENABLE_TESTS=ON
+make
+make test
+make cppcheck
+```
+
+## For testers - both unit tests and code coverage
+
+```
+cd ayatana-indicator-display-X.Y.Z
+mkdir build-coverage
+cd build-coverage
+cmake .. -DENABLE_COVERAGE=ON
+make
+make coverage-html
+```
-- 
cgit v1.2.3