From 9abc758821b848266f268b55376b220fb09fe2f2 Mon Sep 17 00:00:00 2001
From: Robert Tari <robert@tari.in>
Date: Fri, 4 Jun 2021 17:39:18 +0200
Subject: Add documentation and install instructions

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

(limited to 'INSTALL.md')

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..f993e9c
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,51 @@
+# Build and installation instructions
+
+## Compile-time build dependencies
+
+ - cmake (>= 3.13)
+ - cmake-extras
+ - glib-2.0 (>= 2.58)
+ - ayatana-indicator3-0.4 (>= 0.6.2)
+ - gtk+-3.0 (>= 3.24)
+ - ayatana-appindicator3-0.1 (>= 0.5.5)
+ - dbus-glib-1 (>=0.110)
+ - dbusmenu-gtk3-0.4
+ - systemd
+ - intltool
+ - gtest (>= 1.6.0)
+ - gmock
+ - gcovr (>= 2.4)
+ - lcov (>= 1.9)
+
+## For end-users and packagers
+
+```
+cd ayatana-indicator-application-X.Y.Z
+mkdir build
+cd build
+cmake ..
+make
+sudo make install
+```
+## For testers - unit tests only
+
+```
+cd ayatana-indicator-application-X.Y.Z
+mkdir build
+cd build
+cmake .. -DENABLE_TESTS=ON
+make
+make test
+```
+## For testers - both unit tests and code coverage
+
+```
+cd ayatana-indicator-application-X.Y.Z
+mkdir build
+cd build
+cmake .. -DENABLE_COVERAGE=ON
+make
+make test
+make coverage-html
+```
+**The install prefix defaults to `/usr`, change it with `-DCMAKE_INSTALL_PREFIX=/some/path`**
-- 
cgit v1.2.3