rails API support for history of node/segment/way + various bugfixes and cleanups

[rails.git] / README

diff --git a/README b/README
index 74c8ed145ce9f166f773a5de44d79b0c7e492536..c245579a14307fdb54c7d06603c23a5ba3e6b0d1 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,38 @@
+INSTALL
+=======
 
-Task one
-========
+* get rails working (http://www.rubyonrails.org/)
 
-Get OSM on rails with a 0.4 API, without changing the db schema
+* make your db (see db/README)
 
-see db/README for how to create the db
+* install ruby libxml bindings:
 
-Two
-===
+   # sudo aptitude install libxml-ruby1.8 libxml-parser-ruby1.8
 
-change the schema
+* make sure you have a MTA listening on localhost:25 if you want mail
 
+* script/server
+
+* thats it
+
+API CHANGES FOR EDITOR AUTHORS
+==============================
+
+See
+
+http://wiki.openstreetmap.org/index.php/REST#Changes_in_the_upcoming_0.4_API
+
+HACKING
+=======
+
+log in to your site (proably localhost:3000)
+
+create a user and confirm it
+
+you want to play with the API (probably at localhost:3000/api/0.4/node/create etc)
+
+Lots of tests are needed to test the API.
+
+Lots of little things to make the site work like the old one.
+
+Also see the 'rails_port' component for bugs on trac.openstreetmap.org