Nominatim/README.md

64 lines
1.7 KiB
Markdown
Raw Normal View History

[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim)
2012-06-27 23:40:58 +04:00
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 https://nominatim.openstreetmap.org. Nominatim is also used as one of the
sources for the Search box on the OpenStreetMap home page.
2012-06-27 23:40:58 +04:00
Documentation
=============
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/ .
2012-06-27 23:40:58 +04:00
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 at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
as well.
A quick summary of the necessary steps:
2012-06-27 23:40:58 +04:00
1. Compile Nominatim:
mkdir build
cd build
cmake ..
make
2012-06-27 23:40:58 +04:00
2. Get OSM data and import:
./build/utils/setup.php --osm-file <your planet file> --all
3. Point your webserver to the ./build/website directory.
2012-06-27 23:40:58 +04:00
License
=======
The source code is available under a GPLv2 license.
Contributing
============
Contributions are welcome. For details see [CONTRIBUTING.md](contribution guide).
Both bug reports and pull requests are welcome.
Mailing list
============
2012-06-27 23:40:58 +04:00
For questions you can join the geocoding mailinglist, see
https://lists.openstreetmap.org/listinfo/geocoding