fix scene making scripts and add building-parallel-road scene

[nominatim.git] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..7a760ff62251f0cf0477ca28c304faffd28da76a 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,57 @@
+Nominatim
+=========
+
+Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
+by name and address (geocoding) and to generate synthetic addresses of
+OSM points (reverse geocoding). An instance with up-to-date data can be found
+at http://nominatim.openstreetmap.org. Nominatim is also used as one of the
+sources for the Search box on the OpenStreetMap home page and powers the search
+on the MapQuest Open Initiative websites.
+
+Documentation
+=============
+
+More information about Nominatim, including usage and installation instructions,
+can be found in the OSM wiki at:
+
+http://wiki.openstreetmap.org/wiki/Nominatim
+
+Installation
+============
+
+The following instructions is a quick guide to installation. A more detailed guide
+how to set up your own instance of Nominatim can be found in the wiki:
+
+http://wiki.openstreetmap.org/wiki/Nominatim/Installation
+
+Note that this repository contains a submodule called osm2pgsql. Make sure it
+is cloned as well by running `git submodule update --init`.
+
+Installation steps:
+
+1. Compile Nominatim:
+
+     mkdir build
+     cd build
+     cmake ..
+     make
+
+2. Get OSM data and import:
+
+     ./utils/setup.php --osm-file <your planet file> --all
+
+3. Point your webserver to the ./website directory.
+
+License
+=======
+
+The source code is available under a GPLv2 license.
+
+Contact and Bugreports
+======================
+
+For questions you can join the geocoding mailinglist, see
+http://lists.openstreetmap.org/listinfo/geocoding
+
+Bugs may be reported on the github project site:
+https://github.com/twain47/Nominatim