X-Git-Url: https://git.openstreetmap.org/nominatim.git/blobdiff_plain/a52455f1604e5d3233315603da4a14f5b2608319..b2ebf4b4b7c7f12cf5eeb946819a245075980e77:/README.md diff --git a/README.md b/README.md index 70ef5793..80bbfbde 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,40 @@ +[![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 -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. 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 +found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation) +as well. + +A quick summary of the necessary steps: 1. Compile Nominatim: @@ -29,31 +43,29 @@ Here is a quick summary of the necessary steps. cmake .. make - 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 - Details can be found in [docs/Import_and_update.md](docs/Import_and_update.md) - 3. Point your webserver to the ./build/website directory. - 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 are welcome. For details see [contribution guide](CONTRIBUTING.md). + +Both bug reports and pull requests are welcome. + + +Mailing list +============ -Bugs may be reported on the github project site: -https://github.com/openstreetmap/Nominatim +For questions you can join the geocoding mailing list, see +https://lists.openstreetmap.org/listinfo/geocoding