X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/9712decefed0d5a25a636e8f807d30050b1a7b95..9cfd891fb981a2a4241e24c4f3c4b5519eceda48:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 30fb7555..a9a5a3e2 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,24 @@ 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: - -http://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 ============ -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). Detailed installation instructions for the development version can be -found in the `/docs` directory, see [docs/Installation.md](docs/Installation.md). +found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation) +as well. A quick summary of the necessary steps: @@ -48,11 +47,17 @@ 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 are welcome. For details see [contribution guide](CONTRIBUTING.md). + +Both bug reports and pull requests are welcome. -Bugs may be reported on the github project site: -https://github.com/openstreetmap/Nominatim + +Mailing list +============ + +For questions you can join the geocoding mailing list, see +https://lists.openstreetmap.org/listinfo/geocoding