Merge remote-tracking branch 'upstream/pull/3213'

[rails.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 4239ca26715a07602f8331013b018eab236f4ffd..c317c8a9d87383aec0a564568b787d351d93c982 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -12,8 +12,7 @@ are two alternatives which make it easier to get a consistent development enviro
 These instructions are based on Ubuntu 20.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 18.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 software using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md).
 
 ## Dependencies
 
@@ -49,9 +48,9 @@ For Fedora, you can install the minimum requirements with:
 
 ```
 sudo dnf install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
-                 libxml2-devel js \
+                 libxml2-devel nodejs \
                  gcc gcc-c++ git \
-                 postgresql postgresql-server postgresql-contrib \
+                 postgresql postgresql-server postgresql-contrib libpq-devel \
                  perl-podlators ImageMagick libffi-devel gd-devel libarchive-devel \
                  bzip2-devel nodejs-yarn
 ```
@@ -220,7 +219,7 @@ bundle exec rake db:migrate
 To ensure that everything is set up properly, you should now run:
 
 ```
-bundle exec rake test:db
+bundle exec rails test:all
 ```
 
 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.
@@ -245,7 +244,7 @@ After installing this software, you may need to carry out some [configuration st
 
 # Installing compiled shared library database functions (optional)
 
-There are special database functions required by a (little-used) API call, the migrations and diff replication. The former two are provided as *either* pure SQL functions or a compiled shared library. The SQL versions are installed as part of the recommended install procedure above and the shared library versions are recommended only if you are running a production server making a lot of `/changes` API calls or need the diff replication functionality.
+There are special database functions required by a (little-used) API call, the migrations and diff replication. The former two are provided as *either* pure SQL functions or a compiled shared library. The SQL versions are installed as part of the recommended install procedure above and the shared library versions are recommended only if you are running a production server and need the diff replication functionality.
 
 If you aren't sure which you need, stick with the SQL versions.
 
@@ -272,14 +271,12 @@ cd ../..
 If you previously installed the SQL versions of these functions, we'll need to delete those before adding the new ones:
 
 ```
-psql -d openstreetmap -c "DROP FUNCTION IF EXISTS maptile_for_point"
 psql -d openstreetmap -c "DROP FUNCTION IF EXISTS tile_for_point"
 ```
 
 Then we create the functions within each database. We're using `pwd` to substitute in the current working directory, since PostgreSQL needs the full path.
 
 ```
-psql -d openstreetmap -c "CREATE FUNCTION maptile_for_point(int8, int8, int4) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'maptile_for_point' LANGUAGE C STRICT"
 psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
 psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
 ```