X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/7716e0bc92b11ce384a189cf6ca1301a54effd77..9abf2c248ed27a410b3fad92daf4392e660b1c66:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 73c62a20..d130074e 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,31 @@ +[![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. +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: @@ -28,32 +33,45 @@ 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. Create a project directory, get OSM data and import: -2. Get OSM data and import: + mkdir nominatim-project + cd nominatim-project + nominatim import --osm-file - ./build/utils/setup.php --osm-file --all +3. Point your webserver to the nominatim-project/website directory. - 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 Python source code is available under a GPL license version 3 or later. +The Lua configuration files for osm2pgsql are released under the +Apache License, Version 2.0. All other files are under a GPLv2 license. -License -======= +Contributing +============ + +Contributions, bug reports and pull requests are welcome. When reporting a +bug, please use one of the +[issue templates](https://github.com/osm-search/Nominatim/issues/new/choose) +and make sure to provide all the information requested. If you are not +sure if you have really found a bug, please ask for help in the forums +first (see 'Questions' below). + +For details on contributing, have a look at the +[contribution guide](CONTRIBUTING.md). -The source code is available under a GPLv2 license. -Contact and Bugreports -====================== +Questions and help +================== -For questions you can join the geocoding mailinglist, see -http://lists.openstreetmap.org/listinfo/geocoding +If you have questions about search results and the OpenStreetMap data +used in the search, use the [OSM Forum](https://community.openstreetmap.org/). -Bugs may be reported on the github project site: -https://github.com/twain47/Nominatim +For questions, community help and discussions around the software and +your own installation of Nominatim, use the +[Github discussions forum](https://github.com/osm-search/Nominatim/discussions).