diff options
| author | Robert Tari <robert@tari.in> | 2021-07-28 19:10:23 +0200 |
|---|---|---|
| committer | Mike Gabriel <mike.gabriel@das-netzwerkteam.de> | 2021-08-06 16:47:29 +0200 |
| commit | de47a96f104bcbab3c798ce1393d2b5eea5fde82 (patch) | |
| tree | 42d9902e4b6df2ed80e6e34c773789104f3c6238 /INSTALL.md | |
| parent | 672d5f263c2c19396d696cd41f8f10058d1c4c88 (diff) | |
| download | ayatana-indicator-power-de47a96f104bcbab3c798ce1393d2b5eea5fde82.tar.gz ayatana-indicator-power-de47a96f104bcbab3c798ce1393d2b5eea5fde82.tar.bz2 ayatana-indicator-power-de47a96f104bcbab3c798ce1393d2b5eea5fde82.zip | |
Add documentation and build instructions
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..30cb858 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,50 @@ +# Build and installation instructions + +## Compile-time build dependencies + + - cmake (>= 3.13) + - cmake-extras + - libayatana-common (>= 0.9.3) + - glib-2.0 (>= 2.36) + - libnotify (>=0.7.6) + - gettext (>= 0.18) + - systemd + - gcovr (>= 2.4) + - lcov (>= 1.9) + - gtest (>= 1.6.0) + +## For end-users and packagers + +``` +cd ayatana-indicator-power-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-power-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-power-X.Y.Z +mkdir build-coverage +cd build-coverage +cmake .. -DENABLE_COVERAGE=ON +make +make coverage-html +``` |