Merge remote-tracking branch 'upstream/master'

[nominatim.git] / tests / README.md

diff --git a/tests/README.md b/tests/README.md
index 2e8cfa22cca655144996b9447c20141c96a4dba4..1b1663c3544c94b71102915d2ae9839a0db323e5 100644 (file)
--- a/tests/README.md
+++ b/tests/README.md
@@ -15,13 +15,17 @@ Prerequisites
  * nose (https://nose.readthedocs.org)
  * pytidylib (http://countergram.com/open-source/pytidylib)
  * haversine (https://github.com/mapado/haversine)
+ * shapely (https://github.com/Toblerity/Shapely)
 
 Usage
 =====
 
  * get prerequisites
+ 
+     # on a fresh Ubuntu LTS 14.04 you'll also need these system-wide packages
+     [sudo] apt-get install python-dev python-pip python-Levenshtein tidy
 
-     [sudo] pip install lettuce nose pytidylib haversine
+     [sudo] pip install lettuce nose pytidylib haversine psycopg2 shapely
 
  * run the tests
 
@@ -40,6 +44,10 @@ The tests can be configured with a set of environment variables:
                                 the next run. This speeds up tests considerably
                                 but might lead to outdated errors for some
                                 changes in the database layout.
+ * `NOMINATIM_KEEP_SCENARIO_DB` - if defined, the test database will not be
+                                  dropped after a test is finished. Should
+                                  only be used if one single scenario is run,
+                                  otherwise the result is undefined.
  * `LOGLEVEL` - set to 'debug' to get more verbose output (only works properly
                 when output to a logfile is configured)
  * `LOGFILE` - sends debug output to the given file