[postgis-commits] svn - r3625 - spike/wktraster

[postgis-commits at postgis.refractions.net]

Author: strk
Date: 2009-02-03 03:10:03 -0800 (Tue, 03 Feb 2009)
New Revision: 3625

Modified:
   spike/wktraster/README
Log:
updated info

Modified: spike/wktraster/README
===================================================================
--- spike/wktraster/README	2009-02-03 11:02:42 UTC (rev 3624)
+++ spike/wktraster/README	2009-02-03 11:10:03 UTC (rev 3625)
@@ -8,12 +8,53 @@
 set of overlay SQL functions (like ST_Intersects) operating seamlessly
 on vector and raster coverages.
 
+rt_core/ contains the primitives to deal with rasters in memory,
+the function to serialize/deserialize both in-memory and on-disk
+rasters, the functions to parse and output (hex)wkb.
+You can see rt_core/testapi.c and rt_core/testwkb.c for example usage.
 
-This first draft only contains the primitives to deal with
-rasters in memory. You can see rt_core/testapi.c for example
-usage.
+rt_pg/ contains postgresql-specific wrappers, and SQL code to define
+the RASTER type.
 
-To build and run the testapi (a test):
+BUILD
+-----
 
-    ./configure --with-postgis-sources=/usr/src/postgis-xxx
-    make && make check
+To build:
+
+    $ ./configure --with-postgis-sources=/usr/src/postgis-xxx
+    $ make 
+
+CHECK
+-----
+
+After a successful build, you can run:
+
+    $ make check
+
+It won't test postgresql interface, as that would require more setup
+then a simple make check. See INSTALL for more info on how to test
+that part.
+
+INSTALL
+-------
+
+First you need to install the library to the postgresql library
+directory. You do it by running:
+
+    $ make install
+
+Then you need to enable your database to use the new functions.
+It is reccommended to use a test database at first:
+
+    $ createdb test_wktraster
+    $ createlang plpgsql test_wktraster
+    $ psql -f rt_pg/rtpostgis.sql test_wktraster
+
+Then you can run the IO tests against it:
+
+    $ psql -f rt_pg/test/io.sql test_wktraster
+
+The test succeeds if you get all 't' (true) values in last two
+columns of the final query. The data is left on an rt_table
+for use to further test.
+