diff options
author | Robert Tari <robert@tari.in> | 2021-06-04 17:39:18 +0200 |
---|---|---|
committer | Robert Tari <robert@tari.in> | 2021-06-04 17:39:18 +0200 |
commit | 9abc758821b848266f268b55376b220fb09fe2f2 (patch) | |
tree | dd9c85802522e639b427bceb36569b0b12909546 /INSTALL.md | |
parent | 6bac351ab94ae00a27b10a64c7a6a0fcc5e44a49 (diff) | |
download | ayatana-indicator-application-9abc758821b848266f268b55376b220fb09fe2f2.tar.gz ayatana-indicator-application-9abc758821b848266f268b55376b220fb09fe2f2.tar.bz2 ayatana-indicator-application-9abc758821b848266f268b55376b220fb09fe2f2.zip |
Add documentation and install 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 0000000..f993e9c --- /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.58) + - ayatana-indicator3-0.4 (>= 0.6.2) + - gtk+-3.0 (>= 3.24) + - ayatana-appindicator3-0.1 (>= 0.5.5) + - dbus-glib-1 (>=0.110) + - dbusmenu-gtk3-0.4 + - systemd + - intltool + - gtest (>= 1.6.0) + - gmock + - gcovr (>= 2.4) + - lcov (>= 1.9) + +## For end-users and packagers + +``` +cd ayatana-indicator-application-X.Y.Z +mkdir build +cd build +cmake .. +make +sudo make install +``` +## For testers - unit tests only + +``` +cd ayatana-indicator-application-X.Y.Z +mkdir build +cd build +cmake .. -DENABLE_TESTS=ON +make +make test +``` +## For testers - both unit tests and code coverage + +``` +cd ayatana-indicator-application-X.Y.Z +mkdir build +cd build +cmake .. -DENABLE_COVERAGE=ON +make +make test +make coverage-html +``` +**The install prefix defaults to `/usr`, change it with `-DCMAKE_INSTALL_PREFIX=/some/path`** |