]> git.openstreetmap.org Git - nominatim.git/blob - README.md
fix links to documentation in README
[nominatim.git] / README.md
1 Nominatim
2 =========
3
4 Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
5 by name and address (geocoding) and to generate synthetic addresses of
6 OSM points (reverse geocoding). An instance with up-to-date data can be found
7 at http://nominatim.openstreetmap.org. Nominatim is also used as one of the
8 sources for the Search box on the OpenStreetMap home page and powers the search
9 on the MapQuest Open Initiative websites.
10
11 Documentation
12 =============
13
14 More information about Nominatim, including usage and installation instructions,
15 can be found in the docs/ subdirectory and in the OSM wiki at:
16
17 http://wiki.openstreetmap.org/wiki/Nominatim
18
19 Installation
20 ============
21
22 There are detailed installation instructions in the /docs directory.
23 Here is a quick summary of the necessary steps.
24
25 1. Compile Nominatim:
26
27      mkdir build
28      cd build
29      cmake ..
30      make
31
32    For more detailed installation instructions see [docs/Installation.md](docs/Installation.md).
33    There are also step-by-step instructions for
34      [Ubuntu 16.04](docs/install-on-ubuntu-16.md) and
35      [CentOS 7.2](docs/install-on-centos-7.md).
36
37 2. Get OSM data and import:
38
39      ./build/utils/setup.php --osm-file <your planet file> --all
40
41    Details can be found in [docs/Import_and_update.md](docs/Import_and_update.md)
42
43 3. Point your webserver to the ./build/website directory.
44
45
46
47 License
48 =======
49
50 The source code is available under a GPLv2 license.
51
52 Contact and Bugreports
53 ======================
54
55 For questions you can join the geocoding mailinglist, see
56 http://lists.openstreetmap.org/listinfo/geocoding
57
58 Bugs may be reported on the github project site:
59 https://github.com/twain47/Nominatim