]> git.openstreetmap.org Git - nominatim.git/commitdiff
fix formatting of docs
authorSarah Hoffmann <lonvia@denofr.de>
Wed, 8 Jun 2016 21:17:48 +0000 (23:17 +0200)
committerSarah Hoffmann <lonvia@denofr.de>
Wed, 8 Jun 2016 21:17:48 +0000 (23:17 +0200)
docs/Import_and_update.md
docs/Installation.md

index 80e8bf477f44a533425d2456f4ec1c2cd4440903..2f40312aa0b8e56e2cb1d2d0040f7aead55299af 100644 (file)
@@ -45,10 +45,11 @@ Nominatim can use postcodes from an external source to improve searches that inv
     wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
 
 
-Initial Import of the Data
+Initial import of the data
 --------------------------
 
-**Important:** first try the import with a small excerpt, for example from Geofabrik.
+**Important:** first try the import with a small excerpt, for example from
+[Geofabrik](http://download.geofabrik.de).
 
 Download the data to import and load the data with the following command:
 
@@ -57,19 +58,19 @@ Download the data to import and load the data with the following command:
 The --osm2pgsql-cache parameter is optional but strongly recommended for
 planet imports. It sets the node cache size for the osm2pgsql import part
 (see -C parameter in osm2pgsql help). 28GB are recommended for a full planet
-imports, for excerpts you can use less. Adapt to your available RAM to
+import, for excerpts you can use less. Adapt to your available RAM to
 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
 
 
-Loading Additional Datasets
+Loading additional datasets
 ---------------------------
 
 The following commands will create additional entries for countries and POI searches:
 
-    ./utils/specialphrases.php --countries > data/specialphrases_countries.sql
-    psql -d nominatim -f data/specialphrases_countries.sql
-    ./utils/specialphrases.php --wiki-import > data/specialphrases.sql
-    psql -d nominatim -f data/specialphrases.sql
+    ./utils/specialphrases.php --countries > specialphrases_countries.sql
+    psql -d nominatim -f specialphrases_countries.sql
+    ./utils/specialphrases.php --wiki-import > specialphrases.sql
+    psql -d nominatim -f specialphrases.sql
 
 
 Installing Tiger housenumber data for the US
@@ -81,27 +82,25 @@ instance by following these steps:
 
   1. Install the GDAL library and python bindings
 
-       Ubuntu: apt-get install python-gdal
-       CentOS: yum install gdal-python
+       * Ubuntu: `sudo apt-get install python-gdal`
+       * CentOS: `sudo yum install gdal-python`
 
   2. Get the TIGER 2015 data. You will need the EDGES files
-     (3,234 zip files, 11GB total).
+     (3,234 zip files, 11GB total). Choose one of the two sources:
 
-       wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
-       (1gb/s preferred mirror) MIRROR HOSTED BY SHELLBOT, LTD.
+         wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
+         wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
 
-       OR:
-
-       wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
-       (500kb/s original source) HOSTED BY THE US CENSUS BUREAU
+     The first one is the original source, the second a considerably faster
+     mirror.
 
   3. Convert the data into SQL statements (stored in data/tiger): 
 
-       ./utils/imports.php --parse-tiger <tiger edge data directory>
+         ./utils/imports.php --parse-tiger <tiger edge data directory>
 
   4. Import the data into your Nominatim database: 
 
-       ./utils/setup.php --import-tiger-data
+         ./utils/setup.php --import-tiger-data
 
 Be warned that the import can take a very long time, especially if you
 import all of the US.
@@ -112,7 +111,7 @@ Updates
 
 There are many different possibilities to update your Nominatim database.
 The following section describes how to keep it up-to-date with osmosis.
-For a list of other methods see the output of ./utils/update.php --help.
+For a list of other methods see the output of `./utils/update.php --help`.
 
 Installing the newest version of osmosis
 ----------------------------------------
@@ -147,7 +146,7 @@ diffs for Ireland from geofabrik add the following:
     @define('CONST_Replication_Recheck_Interval', '900');
 
 
-Delete existing 'settings/configuration.txt' then run the following command
+Delete any existing `settings/configuration.txt`, then run the following command
 to create the osmosis configuration files:
 
     ./utils/setup.php --osmosis-init
index ddd0fc7b6dbaf802b75ce426fc00d4148344c47d..fd4f8d0b8707916f3ee8e8f70d90989124a3ccab 100644 (file)
@@ -1,4 +1,4 @@
-Nominatim Installation
+Nominatim installation
 ======================
 
 This page contains generic installation instructions for Nominatim and its
@@ -60,10 +60,10 @@ On a 6-core machine with 32GB RAM and SSDs the import of a full planet takes
 a bit more than 2 days. Without SSDs 7-8 days are more realistic.
 
 
-Setup of the Server
+Setup of the server
 -------------------
 
-### PostgreSQL Tuning
+### PostgreSQL tuning
 
 You might want to tune your PostgreSQL installation so that the later steps
 make best use of your hardware. You should tune the following parameters in