aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Gabriel <mike.gabriel@das-netzwerkteam.de>2021-05-23 10:29:28 +0200
committerMike Gabriel <mike.gabriel@das-netzwerkteam.de>2021-05-23 10:29:28 +0200
commit3989df8c9102fe761c1815fa4be2d8414d766e55 (patch)
treeb4110b426dbc8bd328225ae216368c8a418a8e45
parent622d1152108e5af5dacabaac2e46087051a3f5b3 (diff)
parentffd9c2c3abc22938d7911f074922a2880af817db (diff)
downloadlibayatana-common-3989df8c9102fe761c1815fa4be2d8414d766e55.tar.gz
libayatana-common-3989df8c9102fe761c1815fa4be2d8414d766e55.tar.bz2
libayatana-common-3989df8c9102fe761c1815fa4be2d8414d766e55.zip
Merge branch 'tari01-pr/update-docs'
Attributes GH PR #20: https://github.com/AyatanaIndicators/libayatana-common/pull/20
-rw-r--r--INSTALL.md14
-rw-r--r--README.md4
2 files changed, 17 insertions, 1 deletions
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.