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 http://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 http://wiki.openstreetmap.org/wiki/Nominatim
  20
  21 Installation
  22 ============
  23
  24 There are detailed installation instructions in the /docs directory.
  25 Here is a quick summary of the necessary steps.
  26
  27 1. Compile Nominatim:
  28
  29         mkdir build
  30         cd build
  31         cmake ..
  32         make
  33
  34    For more detailed installation instructions see [docs/Installation.md](docs/Installation.md).
  35    There are also step-by-step instructions for
  36      [Ubuntu 16.04](docs/install-on-ubuntu-16.md) and
  37      [CentOS 7.2](docs/install-on-centos-7.md).
  38
  39 2. Get OSM data and import:
  40
  41         ./build/utils/setup.php --osm-file <your planet file> --all
  42
  43    Details can be found in [docs/Import_and_update.md](docs/Import_and_update.md)
  44
  45 3. Point your webserver to the ./build/website directory.
  46
  47
  48
  49 License
  50 =======
  51
  52 The source code is available under a GPLv2 license.
  53
  54 Contact and Bugreports
  55 ======================
  56
  57 For questions you can join the geocoding mailinglist, see
  58 http://lists.openstreetmap.org/listinfo/geocoding
  59
  60 Bugs may be reported on the github project site:
  61 https://github.com/openstreetmap/Nominatim