diff options
author | Robert Tari <robert@tari.in> | 2021-06-23 01:13:56 +0200 |
---|---|---|
committer | Mike Gabriel <mike.gabriel@das-netzwerkteam.de> | 2021-06-27 07:38:03 +0200 |
commit | 0bce1fdc13b64e04ba151c8428c94d7b3974d27d (patch) | |
tree | 74e37351aeed98229de835753ad8c16bdebb1a11 /INSTALL.md | |
parent | 66fdcd86c7de338563e5da1477481a940ab3bd52 (diff) | |
download | ayatana-indicator-datetime-0bce1fdc13b64e04ba151c8428c94d7b3974d27d.tar.gz ayatana-indicator-datetime-0bce1fdc13b64e04ba151c8428c94d7b3974d27d.tar.bz2 ayatana-indicator-datetime-0bce1fdc13b64e04ba151c8428c94d7b3974d27d.zip |
Add install instructions + update documentation
- README.md: Update documentation
- INSTALL.md: Add file
- INSTALL: Drop old file
Diffstat (limited to 'INSTALL.md')
-rw-r--r-- | INSTALL.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..1906f16 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,62 @@ +# Build and installation instructions + +## Compile-time build dependencies + + - cmake (>= 3.13) + - cmake-extras + - libayatana-common (>= 0.9.3) + - glib-2.0 (>= 2.36) + - libical (>=0.48) + - libecal-2.0 (>=3.16) + - libedataserver-1.2 (>=3.5) + - gstreamer-1.0 (>=1.2) + - libnotify (>=0.7.6) + - properties-cpp (>=0.0.1) + - libaccounts-glib (>=1.18) + - gettext (>= 0.18) + - dbus + - gcovr (>= 2.4) + - lcov (>= 1.9) + - gtest (>= 1.6.0) + - dbus-test-runner + - libdbustest1 + - python3-dbusmock + - glibc-locales + - gvfs-daemons + - systemd + +## For end-users and packagers + +``` +cd ayatana-indicator-datetime-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-datetime-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-datetime-X.Y.Z +mkdir build-coverage +cd build-coverage +cmake .. -DENABLE_COVERAGE=ON +make +make coverage-html +``` |