reorganize code around result formatting

[nominatim.git] / README.md

diff --git a/README.md b/README.md
index 30fb75555a9186d9f0e7bbf8e1ec025ce5720fc3..d5041d46b87480f6bad486551e92cb8059bd43a1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim)
+[![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)
+[![codecov](https://codecov.io/gh/osm-search/Nominatim/branch/master/graph/badge.svg?token=8P1LXrhCMy)](https://codecov.io/gh/osm-search/Nominatim)

 
 Nominatim
 =========
 
 Nominatim
 =========


@@ -7,25 +8,23 @@ 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).
+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
-found in the `/docs` directory, see [docs/Installation.md](docs/Installation.md).
+[Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation)
+can be found at nominatim.org as well.

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


@@ -35,12 +34,15 @@ A quick summary of the necessary steps:
         cd build
         cmake ..
         make
         cd build
         cmake ..
         make

+        sudo make install

 
 

-2. Get OSM data and import:
+2. Create a project directory, get OSM data and import:

 
 

-        ./build/utils/setup.php --osm-file <your planet file> --all
+        mkdir nominatim-project
+        cd nominatim-project
+        nominatim import --osm-file <your planet file>

 
 

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

 
 
 License
 
 
 License


@@ -48,11 +50,18 @@ 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, 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/openstreetmap/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).