Document installation of database functions on MacOS X.

[rails.git] / db / README

diff --git a/db/README b/db/README
index 466a16cc475586a8287b97627c4cf9cb7a6a5b40..d89a67bfb8bfb0603aac985e4dbd5295a3deff66 100644 (file)
--- a/db/README
+++ b/db/README
@@ -1,36 +1,65 @@
 Creating database
-=====================
+===================
 
-OSM server use databse with follow name :
+OSM server uses a database with the following name:
 
 openstreetmap
 
-You may create it with your prefrable client or run next (linux) command :
+You may create it with your preferable client or run next (linux) command:
 
 $ mysqladmin -u <uid> -p create openstreetmap
 
-(change <uid> with appropriate username of administrativ user eg. root )
+(change <uid> with appropriate username of administrative user eg. root )
 
-Creating user, password, and access rightts
-=============================================
+Creating user, password, and access rights
+============================================
 
 $ mysql -u <uid> -p
 
-(change <uid> with appropriate username of administrativ user eg. root )
+(change <uid> with appropriate username of administrative user eg. root )
 
 > grant all privileges on openstreetmap.* to 'openstreetmap'@'localhost' identified by 'openstreetmap';
 > flush privileges;
 > exit
 
-Creating database skeleton tables
-===================================
+Creating functions
+====================
+
+Run this command in the db/functions directory:
+
+$ make
+
+The above command should work for linux and most other Unix systems
+that use ELF shared objects. For MacOS X you will need to do:
+
+$ make libquadtile.dylib
+
+Make sure the db/functions directory is on the MySQL server's library
+path and restart the MySQL server. On linux the easiest way to do this
+is to create /etc/ld.so.conf.d/osm.conf and place the path to the
+db/functions directory in it and then run the following command as root:
+
+$ ldconfig
+
+Now create the functions as follows:
 
-$ mysql openstreetmap -u openstreetmap -p < db/create_database.sql
+$ mysql -u <uid> -p openstreetmap
 
-New server patch (RAILS)
-==========================
+(change <uid> with appropriate username of administrative user eg. root )
+
+> create function tile_for_point returns integer soname 'libquadtile.so';
+> exit
+
+or, for MacOS X:
+
+> create function tile_for_point returns integer soname 'libquadtile.dylib';
+> exit
+
+Creating database skeleton tables
+===================================
 
-Run follow command to prepare tables to be OSM REILS distribution compatible :
+Run this command from the root of your rails directory:
 
-$ mysql openstreetmap -u openstreetmap -p < db/migrate.sql
+$ rake db:migrate
 
+This will create the db for you