README

   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 OSM wiki at:
  16
  17 http://wiki.openstreetmap.org/wiki/Nominatim
  18
  19 Installation
  20 ============
  21
  22 The following instructions is a quick guide to installation. A more detailed guide
  23 how to set up your own instance of Nominatim can be found in the wiki:
  24
  25 http://wiki.openstreetmap.org/wiki/Nominatim/Installation
  26
  27 Note that this repository contains a submodule called osm2pgsql. Make sure it
  28 is cloned as well by running `git submodule update --init`.
  29
  30 Installation 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      ./utils/setup.php --osm-file <your planet file> --all
  42
  43 3. Point your webserver to the ./website directory.
  44
  45 License
  46 =======
  47
  48 The source code is available under a GPLv2 license.
  49
  50 Contact and Bugreports
  51 ======================
  52
  53 For questions you can join the geocoding mailinglist, see
  54 http://lists.openstreetmap.org/listinfo/geocoding
  55
  56 Bugs may be reported on the github project site:
  57 https://github.com/twain47/Nominatim