From 798026632d2466b92f0deb89a6342bc05df7711e Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Wed, 18 Oct 2023 11:37:58 +0200 Subject: [PATCH] chore(linux): Update readme --- docs/linux/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/linux/README.md b/docs/linux/README.md index 354ee895318..8ee91fbe81e 100644 --- a/docs/linux/README.md +++ b/docs/linux/README.md @@ -89,6 +89,21 @@ The `run-tests` script accepts different arguments which can be seen with ### Code Coverage Report +#### Prerequisites + +Code coverage reports require some additional tools: lcov, gcovr, +libdatetime-perl, and coverage. + +You can install these with: + +```bash +sudo apt update +sudo apt install -y lcov libdatetime-perl gcovr +pip3 install coverage +``` + +#### Creating and displaying code coverage reports + All three projects (ibus-keyman, keyman-config, and keyman-system-service) can produce code coverage reports.