diff options
| author | Robert Tari <robert@tari.in> | 2021-07-29 01:05:09 +0200 |
|---|---|---|
| committer | Mike Gabriel <mike.gabriel@das-netzwerkteam.de> | 2021-08-04 12:20:41 +0200 |
| commit | 6bf9165df5e22792b7470d7946077d85533412fc (patch) | |
| tree | f89c0ea390bc842776865680345af692e3920f5d /INSTALL.md | |
| parent | 6dc8e402200927d298ff63fe34e1c9a06a2e07e0 (diff) | |
| download | ayatana-indicator-keyboard-6bf9165df5e22792b7470d7946077d85533412fc.tar.gz ayatana-indicator-keyboard-6bf9165df5e22792b7470d7946077d85533412fc.tar.bz2 ayatana-indicator-keyboard-6bf9165df5e22792b7470d7946077d85533412fc.zip | |
Add documentation and build instructions
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 51 |
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 +``` |