Use check_import_finished in test suite, document

[nominatim.git] / README.md

diff --git a/README.md b/README.md
index 30fb75555a9186d9f0e7bbf8e1ec025ce5720fc3..1ae0dab029ab6c194e59f468eb2030a3b799ff3d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,25 +7,32 @@ Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
 by name and address (geocoding) and to generate synthetic addresses of
 OSM points (reverse geocoding). An instance with up-to-date data can be found
 at https://nominatim.openstreetmap.org. Nominatim is also used as one of the
 by name and address (geocoding) and to generate synthetic addresses of
 OSM points (reverse geocoding). An instance with up-to-date data can be found
 at https://nominatim.openstreetmap.org. Nominatim is also used as one of the

-sources for the Search box on the OpenStreetMap home page and powers the search
-on the MapQuest Open Initiative websites.
+sources for the Search box on the OpenStreetMap home page.

 
 Documentation
 =============
 
 
 Documentation
 =============
 

-More information about Nominatim, including usage and installation instructions,
-can be found in the docs/ subdirectory and in the OSM wiki at:
-
-http://nominatim.org
+The documentation of the latest development version is in the
+`docs/` subdirectory. A HTML version can be found at
+https://nominatim.org/release-docs/develop/ .

 
 Installation
 ============
 
 
 Installation
 ============
 

-The latest stable release can be downloaded from http://nominatim.org.
-There you can also find [installation instructions for the release](http://nominatim.org/release-docs/latest/Installation).
+**Nominatim is a complex piece of software and runs in a complex environment.
+Installing and running Nominatim is something for experienced system
+administrators only who can do some trouble-shooting themselves. We are sorry,
+but we can not provide installation support. We are all doing this in our free
+time and there is just so much of that time to go around. Do not open issues in
+our bug tracker if you need help. You can ask questions on the mailing list
+(see below) or on [help.openstreetmap.org](https://help.openstreetmap.org/).**
+
+The latest stable release can be downloaded from https://nominatim.org.
+There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation), as well as an extensive [Troubleshooting/FAQ section](https://nominatim.org/release-docs/latest/admin/Faq/).

 
 Detailed installation instructions for the development version can be
 
 Detailed installation instructions for the development version can be

-found in the `/docs` directory, see [docs/Installation.md](docs/Installation.md).
+found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
+as well.

 
 A quick summary of the necessary steps:
 
 
 A quick summary of the necessary steps:
 


@@ -48,11 +55,17 @@ License
 
 The source code is available under a GPLv2 license.
 
 
 The source code is available under a GPLv2 license.
 

-Contact and Bug reports
-======================

 
 

-For questions you can join the geocoding mailinglist, see
-https://lists.openstreetmap.org/listinfo/geocoding
+Contributing
+============
+
+Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md).

 
 

-Bugs may be reported on the github project site:
-https://github.com/openstreetmap/Nominatim
+Both bug reports and pull requests are welcome.
+
+
+Mailing list
+============
+
+For questions you can join the geocoding mailing list, see
+https://lists.openstreetmap.org/listinfo/geocoding