Fix rubocop issue

[rails.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 0343629110c39f2e1ca128547483a64e0e9e5d69..c05ccdbba85aec170c4f5ab8f06ad43fab62baf4 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -8,7 +8,7 @@ You can install the software directly on your machine, which is the traditional
 These instructions are based on Ubuntu 12.04 LTS, which is the platform used by the OSMF servers.
 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
 
 These instructions are based on Ubuntu 12.04 LTS, which is the platform used by the OSMF servers.
 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
 

-We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this sofware using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md).
+We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this software using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md).

 
 ## Dependencies
 
 
 ## Dependencies
 


@@ -18,22 +18,22 @@ of packages required before you can get the various gems installed.
 
 ## Minimum requirements
 
 
 ## Minimum requirements
 

-* Ruby 2.0
+* Ruby 2.3

 * RubyGems 1.3.1+
 * RubyGems 1.3.1+

-* Postgres 8.3+
+* PostgreSQL 9.1+

 * ImageMagick
 * Bundler
 * Javascript Runtime
 
 * ImageMagick
 * Bundler
 * Javascript Runtime
 

-These can be installed on Ubuntu 14.04 or later with:
+These can be installed on Ubuntu 16.04 or later with:

 
 ```
 
 ```

-sudo apt-get install ruby2.0 libruby2.0 ruby2.0-dev \
+sudo apt-get install ruby2.3 libruby2.3 ruby2.3-dev \

                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \
                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \

-                     apache2 apache2-threaded-dev build-essential git-core \
+                     apache2 apache2-dev build-essential git-core \

                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \
                      libsasl2-dev imagemagick
                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \
                      libsasl2-dev imagemagick

-sudo gem2.0 install bundler
+sudo gem2.3 install bundler

 ```
 
 ### Alternative platforms
 ```
 
 ### Alternative platforms


@@ -50,14 +50,14 @@ sudo yum install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
                  perl-podlators ImageMagick
 ```
 
                  perl-podlators ImageMagick
 ```
 

-If you didn't already have Postgres installed then create a Postgres instance and start the server:
+If you didn't already have PostgreSQL installed then create a PostgreSQL instance and start the server:

 
 ```
 sudo postgresql-setup initdb
 sudo systemctl start postgresql.service
 ```
 
 
 ```
 sudo postgresql-setup initdb
 sudo systemctl start postgresql.service
 ```
 

-Optionally set Postgres to start on boot:
+Optionally set PostgreSQL to start on boot:

 
 ```
 sudo systemctl enable postgresql.service
 
 ```
 sudo systemctl enable postgresql.service


@@ -67,10 +67,10 @@ sudo systemctl enable postgresql.service
 
 For MacOSX, you will need XCode installed from the Mac App Store; OS X 10.7 (Lion) or later; and some familiarity with Unix development via the Terminal.
 
 
 For MacOSX, you will need XCode installed from the Mac App Store; OS X 10.7 (Lion) or later; and some familiarity with Unix development via the Terminal.
 

-Installing Postgres:
+Installing PostgreSQL:

 
 * Install Postgres.app from http://postgresapp.com/
 
 * Install Postgres.app from http://postgresapp.com/

-* Add Postgres to your path, by editing your profile:
+* Add PostgreSQL to your path, by editing your profile:

 
 `nano ~/.profile`
 
 
 `nano ~/.profile`
 


@@ -81,9 +81,10 @@ and adding:
 Installing other dependencies:
 
 * Install Homebrew from http://mxcl.github.io/homebrew/
 Installing other dependencies:
 
 * Install Homebrew from http://mxcl.github.io/homebrew/

-* Install the latest version of Ruby: brew install ruby
-* Install ImageMagick: brew install imagemagick
-* Install Bundler: gem install bundler
+* Install the latest version of Ruby: `brew install ruby`
+* Install ImageMagick: `brew install imagemagick`
+* Install libxml2: `brew install libxml2 --with-xml2-config`
+* Install Bundler: `gem install bundler`

 
 Note that OS X does not have a /home directory by default, so if you are using the GPX functions, you will need to change the directories specified in config/application.yml.
 
 
 Note that OS X does not have a /home directory by default, so if you are using the GPX functions, you will need to change the directories specified in config/application.yml.
 


@@ -138,7 +139,7 @@ instructions below as appropriate.
 
 ### PostgreSQL account setup
 
 
 ### PostgreSQL account setup
 

-We need to create a PostgreSQL role (i.e. user account) for your current user, and it needs to be a superuser so that we can create more database.
+We need to create a PostgreSQL role (i.e. user account) for your current user, and it needs to be a superuser so that we can create more databases.

 
 ```
 sudo -u postgres -i
 
 ```
 sudo -u postgres -i


@@ -156,7 +157,7 @@ bundle exec rake db:create
 
 ### PostgreSQL Btree-gist Extension
 
 
 ### PostgreSQL Btree-gist Extension
 

-We need to load the btree-gist extension, which is needed for showing changesets on the history tab.
+We need to load the `btree-gist` extension, which is needed for showing changesets on the history tab.

 
 ```
 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 
 ```
 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"


@@ -164,7 +165,7 @@ psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 
 ### PostgreSQL Functions
 
 
 ### PostgreSQL Functions
 

-We need to install special functions into the postgresql databases, and these are provided by a library that needs compiling first.
+We need to install special functions into the PostgreSQL databases, and these are provided by a library that needs compiling first.

 
 ```
 cd db/functions
 
 ```
 cd db/functions