X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/909b0c7462b336d07cab4499529957a4096a8c18..4e59efa1783534a262e49901b6bfbf84b2d7f108:/README.md diff --git a/README.md b/README.md index 42c4d72c..3b0f328a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![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) Nominatim ========= @@ -6,53 +6,72 @@ 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 ============ -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: -1. Compile Nominatim: +1. Create a Python virtualenv and install the packages: + + python3 -m venv nominatim-venv + ./nominatim-venv/bin/pip install packaging/nominatim-{api,db} - mkdir build - cd build - cmake .. - make +2. Create a project directory, get OSM data and import: -2. Get OSM data and import: + mkdir nominatim-project + cd nominatim-project + ../nominatim-venv/bin/nominatim import --osm-file - ./build/utils/setup.php --osm-file --all +3. Start the webserver: -3. Point your webserver to the ./build/website directory. + ./nominatim-venv/bin/pip install uvicorn falcon + ../nominatim-venv/bin/nominatim serve License ======= -The source code is available under a GPLv2 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. + + +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). + -Contact and Bug reports -====================== +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/openstreetmap/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).