chore(linux): Update readme

keymanapp · Oct 18, 2023 · 7980266 · 7980266
1 parent 2a19a2f
commit 7980266
Showing 1 changed file with 15 additions and 0 deletions.
diff --git 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.