X-Git-Url: https://git.openstreetmap.org/nominatim.git/blobdiff_plain/6985abc3fd16dd5a8f8de91ec1d798238ea10709..909b0c7462b336d07cab4499529957a4096a8c18:/test/README.md

diff --git a/test/README.md b/test/README.md
index f6112620..f6c1ac2a 100644
--- a/test/README.md
+++ b/test/README.md
@@ -120,6 +120,21 @@ Before importing make sure to add the following to your local settings:
     @define('CONST_Database_DSN', 'pgsql://@/test_api_nominatim');
     @define('CONST_Wikipedia_Data_Path', CONST_BasePath.'/test/testdb');
 
+#### Code Coverage
+
+The API tests also support code coverage tests. You need to install
+PHP_CodeCoverage. On Debian/Ubuntu run:
+
+    apt-get install php-codecoverage
+
+The run the API tests as follows:
+
+    behave api -DPHPCOV=<coverage output dir>
+
+To generate reports, you can use the phpcov tool:
+
+    phpcov merge --html=<report output dir> <coverage output dir>
+
 ### Indexing Tests (`test/bdd/db`)
 
 These tests check the import and update of the Nominatim database. They do not