]> git.openstreetmap.org Git - nominatim.git/blob - README.md
Merge pull request #2856 from t-tomek/patch-1
[nominatim.git] / README.md
1 [![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)
2 [![codecov](https://codecov.io/gh/osm-search/Nominatim/branch/master/graph/badge.svg?token=8P1LXrhCMy)](https://codecov.io/gh/osm-search/Nominatim)
3
4 Nominatim
5 =========
6
7 Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
8 by name and address (geocoding) and to generate synthetic addresses of
9 OSM points (reverse geocoding). An instance with up-to-date data can be found
10 at https://nominatim.openstreetmap.org. Nominatim is also used as one of the
11 sources for the Search box on the OpenStreetMap home page.
12
13 Documentation
14 =============
15
16 The documentation of the latest development version is in the
17 `docs/` subdirectory. A HTML version can be found at
18 https://nominatim.org/release-docs/develop/ .
19
20 Installation
21 ============
22
23 The latest stable release can be downloaded from https://nominatim.org.
24 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/).
25
26 [Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation)
27 can be found at nominatim.org 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         sudo make install
38
39 2. Create a project directory, get OSM data and import:
40
41         mkdir nominatim-project
42         cd nominatim-project
43         nominatim import --osm-file <your planet file>
44
45 3. Point your webserver to the nominatim-project/website directory.
46
47
48 License
49 =======
50
51 The source code is available under a GPLv2 license.
52
53
54 Contributing
55 ============
56
57 Contributions, bugreport and pull requests are welcome.
58 For details see [contribution guide](CONTRIBUTING.md).
59
60
61 Questions and help
62 ==================
63
64 For questions, community help and discussions you can use the
65 [Github discussions forum](https://github.com/osm-search/Nominatim/discussions)
66 or join the
67 [geocoding mailing list](https://lists.openstreetmap.org/listinfo/geocoding).