consolidate warm and db-check into single admin command

[nominatim.git] / README.md

diff --git a/README.md b/README.md
index c5a01a3623d68982bc4d0926e6d843b20a3c0d90..d4bb0936657cd2d57de351aaa836faf1fa4951d1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,47 +1,54 @@
+[![Build Status](https://github.com/osm-search/Nominatim/workflows/CI%20Tests/badge.svg)](https://github.com/osm-search/Nominatim/actions?query=workflow%3A%22CI+Tests%22)
+

 Nominatim
 =========
 
 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
 Nominatim
 =========
 
 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 http://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.
+at https://nominatim.openstreetmap.org. Nominatim is also used as one of the
+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://wiki.openstreetmap.org/wiki/Nominatim
+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
 ============
 

-There are detailed installation instructions in the /docs directory.
-Here is a quick summary of the necessary steps.
+**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. Use the discussions forum
+or ask for help on [help.openstreetmap.org](https://help.openstreetmap.org/).**

 
 

-1. Compile Nominatim:
+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/).

 
 

-     mkdir build
-     cd build
-     cmake ..
-     make
+[Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation)
+can be found at nominatim.org as well.

 
 

-   For more detailed installation instructions see [docs/installation.md]().
-   There are also step-by-step instructions for
-     [Ubuntu 16.04](docs/install-on-ubuntu-16.md) and
-     [CentOS 7.2](docs/install-on-centos-7.md).
+A quick summary of the necessary steps:

 
 

-2. Get OSM data and import:
+1. Compile Nominatim:

 
 

-     ./build/utils/setup.php --osm-file <your planet file> --all
+        mkdir build
+        cd build
+        cmake ..
+        make

 
 

-   Details can be found in [docs/Import_and_update.md]()
+2. Create a project directory, get OSM data and import:

 
 

-3. Point your webserver to the ./build/website directory.
+        mkdir nominatim-project
+        cd nominatim-project
+        ~/build/nominatim import --osm-file <your planet file>

 
 

+3. Point your webserver to the nominatim-project/website directory.

 
 
 License
 
 
 License


@@ -49,11 +56,18 @@ License
 
 The source code is available under a GPLv2 license.
 
 
 The source code is available under a GPLv2 license.
 

-Contact and Bugreports
-======================

 
 

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

 
 

-Bugs may be reported on the github project site:
-https://github.com/twain47/Nominatim
+For questions, community help and discussions you can use the
+[Github discussions forum](https://github.com/osm-search/Nominatim/discussions)
+or join the
+[geocoding mailing list](https://lists.openstreetmap.org/listinfo/geocoding).