X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/051998dd80b0def50058266b7adbdf2e971032eb..2ab836c11c3f4aa57a71aec18594ae59566b850c:/README.md?ds=inline diff --git a/README.md b/README.md index c5a01a36..a9a5a3e2 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,63 @@ +[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim) + 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). -1. Compile Nominatim: +Detailed installation instructions for the development version can be +found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation) +as well. - mkdir build - cd build - cmake .. - make +A quick summary of the necessary steps: - For more detailed installation instructions see [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). +1. Compile Nominatim: -2. Get OSM data and import: + mkdir build + cd build + cmake .. + make - ./build/utils/setup.php --osm-file --all +2. Get OSM data and import: - Details can be found in [docs/Import_and_update.md]() + ./build/utils/setup.php --osm-file --all 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/twain47/Nominatim +For questions you can join the geocoding mailing list, see +https://lists.openstreetmap.org/listinfo/geocoding