aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorMike Gabriel <mike.gabriel@das-netzwerkteam.de>2021-08-04 12:22:30 +0200
committerMike Gabriel <mike.gabriel@das-netzwerkteam.de>2021-08-04 12:22:30 +0200
commit39a3583e587f614968e5e85049fb1d927a0e5404 (patch)
treef89c0ea390bc842776865680345af692e3920f5d /INSTALL.md
parent6dc8e402200927d298ff63fe34e1c9a06a2e07e0 (diff)
parent6bf9165df5e22792b7470d7946077d85533412fc (diff)
downloadayatana-indicator-keyboard-39a3583e587f614968e5e85049fb1d927a0e5404.tar.gz
ayatana-indicator-keyboard-39a3583e587f614968e5e85049fb1d927a0e5404.tar.bz2
ayatana-indicator-keyboard-39a3583e587f614968e5e85049fb1d927a0e5404.zip
Merge branch 'tari01-pr/add-documentation-and-build-instructions'
Attributes GH PR #13: https://github.com/AyatanaIndicators/ayatana-indicator-keyboard/pull/13
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md51
1 files changed, 51 insertions, 0 deletions
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
+```