X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/13469e1576e29f24b220ed1749ae143a0094d204..7dfe645b5f2fcfc320264baad73f52c8003e857f:/README.md diff --git a/README.md b/README.md index fae9b72d..d4bb0936 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 ========= @@ -7,25 +7,31 @@ 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 -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 ============= -More information about Nominatim, including usage and installation instructions, -can be found in the docs/ subdirectory and in the OSM wiki at: - -https://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 ============ +**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/Installation). +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: @@ -36,11 +42,13 @@ A quick summary of the necessary steps: cmake .. make -2. Get OSM data and import: +2. Create a project directory, get OSM data and import: - ./build/utils/setup.php --osm-file --all + mkdir nominatim-project + cd nominatim-project + ~/build/nominatim import --osm-file -3. Point your webserver to the ./build/website directory. +3. Point your webserver to the nominatim-project/website directory. License @@ -48,11 +56,18 @@ 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).