From 1ea81c7143677fb809091c6637644b1e74c8644b Mon Sep 17 00:00:00 2001
From: Robert Tari <robert@tari.in>
Date: Mon, 18 Oct 2021 03:32:12 +0200
Subject: Add info and build instructions

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

(limited to 'INSTALL.md')

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..3d5dccd
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,54 @@
+# Build and installation instructions
+
+## Compile-time build dependencies
+
+ - cmake (>= 3.13)
+ - cmake-extras
+ - intltool
+ - vala (>= 0.20)
+ - systemd
+ - glib-2.0 (>= 2.36)
+ - accountsservice
+ - gobject-introspection
+ - gtk-doc
+ - gtest (>= 1.6.0) - **For testing**
+ - python3-dbusmock - **For testing**
+ - dbus-test-runner - **For testing**
+ - gcovr (>= 2.4) - **For coverage**
+ - lcov (>= 1.9) - **For coverage**
+
+## For end-users and packagers
+
+```
+cd ayatana-indicator-messages-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-messages-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-messages-X.Y.Z
+mkdir build-coverage
+cd build-coverage
+cmake .. -DENABLE_COVERAGE=ON
+make
+make coverage-html
+```
-- 
cgit v1.2.3