X-Git-Url: https://git.openstreetmap.org/nominatim.git/blobdiff_plain/e4a76f2d7ec202875345528b0bce9f3b83f282ee..73953cbac95847740339d7a5ee3c0e5f142d93c5:/README.md diff --git a/README.md b/README.md index 46c419fa..b643088b 100644 --- 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 ========= @@ -6,23 +7,34 @@ 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 ============= -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 ============ -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/).** + +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 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: 1. Compile Nominatim: @@ -30,20 +42,15 @@ Here is a quick summary of the necessary steps. cd build cmake .. make + sudo make install - For more detailed installation instructions see [docs/Installation.md](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). - -2. Get OSM data and import: - - ./build/utils/setup.php --osm-file --all +2. Create a project directory, get OSM data and import: - Details can be found in [docs/Import_and_update.md](docs/Import_and_update.md) - -3. Point your webserver to the ./build/website directory. + mkdir nominatim-project + cd nominatim-project + nominatim import --osm-file +3. Point your webserver to the nominatim-project/website directory. License @@ -51,11 +58,18 @@ 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/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).