From 6bf9165df5e22792b7470d7946077d85533412fc Mon Sep 17 00:00:00 2001
From: Robert Tari <robert@tari.in>
Date: Thu, 29 Jul 2021 01:05:09 +0200
Subject: Add documentation and build 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 00000000..bf2200a4
--- /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.36)
+ - gio-2.0 (>=2.36)
+ - x11 (>=1.6.7)
+ - libxklavier (>=5.4)
+ - intltool
+ - systemd
+ - gcovr (>= 2.4)
+ - lcov (>= 1.9)
+ - gtest (>= 1.6.0)
+
+## For end-users and packagers
+
+```
+cd ayatana-indicator-keyboard-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-keyboard-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-keyboard-X.Y.Z
+mkdir build-coverage
+cd build-coverage
+cmake .. -DENABLE_COVERAGE=ON
+make
+make coverage-html
+```
-- 
cgit v1.2.3