]> git.openstreetmap.org Git - nominatim.git/blob - README.md
prepare for 3.3.0 release
[nominatim.git] / README.md
1 [![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim)
2
3 Nominatim
4 =========
5
6 Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
7 by name and address (geocoding) and to generate synthetic addresses of
8 OSM points (reverse geocoding). An instance with up-to-date data can be found
9 at https://nominatim.openstreetmap.org. Nominatim is also used as one of the
10 sources for the Search box on the OpenStreetMap home page.
11
12 Documentation
13 =============
14
15 The documentation of the latest development version is in the
16 `docs/` subdirectory. A HTML version can be found at
17 https://nominatim.org/release-docs/develop/ .
18
19 Installation
20 ============
21
22 The latest stable release can be downloaded from https://nominatim.org.
23 There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation).
24
25 Detailed installation instructions for the development version can be
26 found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
27 as well.
28
29 A quick summary of the necessary steps:
30
31 1. Compile Nominatim:
32
33         mkdir build
34         cd build
35         cmake ..
36         make
37
38 2. Get OSM data and import:
39
40         ./build/utils/setup.php --osm-file <your planet file> --all
41
42 3. Point your webserver to the ./build/website directory.
43
44
45 License
46 =======
47
48 The source code is available under a GPLv2 license.
49
50
51 Contributing
52 ============
53
54 Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md).
55
56 Both bug reports and pull requests are welcome.
57
58
59 Mailing list
60 ============
61
62 For questions you can join the geocoding mailing list, see
63 https://lists.openstreetmap.org/listinfo/geocoding