]> git.openstreetmap.org Git - nominatim.git/blobdiff - README.md
normalize postcodes before adding to location tables
[nominatim.git] / README.md
index c5a01a3623d68982bc4d0926e6d843b20a3c0d90..5059473c6aec84428b6be9e866aa0bd2ae55b409 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim)
+
 Nominatim
 =========
 
@@ -24,21 +26,21 @@ Here is a quick summary of the necessary steps.
 
 1. Compile Nominatim:
 
-     mkdir build
-     cd build
-     cmake ..
-     make
+        mkdir build
+        cd build
+        cmake ..
+        make
 
-   For more detailed installation instructions see [docs/installation.md]().
+   For more detailed installation instructions see [docs/Installation.md](docs/Installation.md).
    There are also step-by-step instructions for
-     [Ubuntu 16.04](docs/install-on-ubuntu-16.md) and
-     [CentOS 7.2](docs/install-on-centos-7.md).
+     [Ubuntu 16.04](docs/Install-on-Ubuntu-16.md) and
+     [CentOS 7.2](docs/Install-on-Centos-7.md).
 
 2. Get OSM data and import:
 
-     ./build/utils/setup.php --osm-file <your planet file> --all
+        ./build/utils/setup.php --osm-file <your planet file> --all
 
-   Details can be found in [docs/Import_and_update.md]()
+   Details can be found in [docs/Import_and_update.md](docs/Import-and-Update.md)
 
 3. Point your webserver to the ./build/website directory.
 
@@ -49,11 +51,11 @@ License
 
 The source code is available under a GPLv2 license.
 
-Contact and Bugreports
+Contact and Bug reports
 ======================
 
 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
+https://github.com/openstreetmap/Nominatim