From ffd9c2c3abc22938d7911f074922a2880af817db Mon Sep 17 00:00:00 2001 From: Robert Tari Date: Mon, 17 May 2021 22:04:07 +0200 Subject: Update documentation files --- INSTALL.md | 14 +++++++++++++- README.md | 4 ++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 19b6373..e2e99b7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,8 +1,18 @@ # Build and installation instructions +## Compile-time build dependencies + + - glib-2.0 (>= 2.36) + - cmake (>= 3.13) + - cmake-extras + - gtest (>= 1.6.0) + - gcovr (>= 2.4) + - lcov (>= 1.9) + ## For end-users and packagers ``` +cd libayatana-common-X.Y.Z mkdir build cd build cmake .. @@ -12,6 +22,7 @@ sudo make install ## For testers - unit tests only ``` +cd libayatana-common-X.Y.Z mkdir build cd build cmake .. -DENABLE_TESTS=ON @@ -21,11 +32,12 @@ make test ## For testers - both unit tests and code coverage ``` +cd libayatana-common-X.Y.Z mkdir build cd build cmake .. -DENABLE_COVERAGE=ON make make test -make coverage +make coverage-html ``` **The install prefix defaults to `/usr`, change it with `-DCMAKE_INSTALL_PREFIX=/some/path`** diff --git a/README.md b/README.md index 4419c9d..617bdff 100644 --- a/README.md +++ b/README.md @@ -43,3 +43,7 @@ across various system indicator components. ## License and Copyright See COPYING and AUTHORS file in this project. + +## Building and Testing + +For instructions on building and running built-in tests, see the INSTALL.md file. -- cgit v1.2.3