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 and powers the search
  11 on the MapQuest Open Initiative websites.
  12
  13 Documentation
  14 =============
  15
  16 More information about Nominatim, including usage and installation instructions,
  17 can be found in the docs/ subdirectory and in the OSM wiki at:
  18
  19 https://nominatim.org
  20
  21 Installation
  22 ============
  23
  24 The latest stable release can be downloaded from https://nominatim.org.
  25 There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/Installation).
  26
  27 Detailed installation instructions for the development version can be
  28 found in the `/docs` directory, see [docs/Installation.md](docs/Installation.md).
  29
  30 A quick summary of the necessary steps:
  31
  32 1. Compile Nominatim:
  33
  34         mkdir build
  35         cd build
  36         cmake ..
  37         make
  38
  39 2. Get OSM data and import:
  40
  41         ./build/utils/setup.php --osm-file <your planet file> --all
  42
  43 3. Point your webserver to the ./build/website directory.
  44
  45
  46 License
  47 =======
  48
  49 The source code is available under a GPLv2 license.
  50
  51 Contact and Bug reports
  52 ======================
  53
  54 For questions you can join the geocoding mailinglist, see
  55 https://lists.openstreetmap.org/listinfo/geocoding
  56
  57 Bugs may be reported on the github project site:
  58 https://github.com/openstreetmap/Nominatim