diff options
| author | Robert Tari <robert@tari.in> | 2021-07-28 23:08:45 +0200 |
|---|---|---|
| committer | Mike Gabriel <mike.gabriel@das-netzwerkteam.de> | 2021-08-04 16:02:10 +0200 |
| commit | c200a3d1cf5a6fab281274aa559c0119ca70bee4 (patch) | |
| tree | 34427e8d32328ebc7a71fd8478bf7a11c6096067 /INSTALL.md | |
| parent | cbfecc6afcc9976506925ec124364aaa99a03f8f (diff) | |
| download | ayatana-indicator-bluetooth-c200a3d1cf5a6fab281274aa559c0119ca70bee4.tar.gz ayatana-indicator-bluetooth-c200a3d1cf5a6fab281274aa559c0119ca70bee4.tar.bz2 ayatana-indicator-bluetooth-c200a3d1cf5a6fab281274aa559c0119ca70bee4.zip | |
Add documentation and build instructions
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..9cef72a --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,49 @@ +# Build and installation instructions + +## Compile-time build dependencies + + - cmake (>= 3.13) + - cmake-extras + - glib-2.0 (>= 2.36) + - intltool + - systemd + - vala (>= 0.20) + - gcovr (>= 2.4) + - lcov (>= 1.9) + - gtest (>= 1.6.0) + +## For end-users and packagers + +``` +cd ayatana-indicator-bluetooth-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-bluetooth-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-bluetooth-X.Y.Z +mkdir build-coverage +cd build-coverage +cmake .. -DENABLE_COVERAGE=ON +make +make coverage-html +``` |