nnnnnnnnnnnnnnnnnnnnnngh
[potlatch2.git] / README.txt
index 33e3f3a..d740d27 100644 (file)
@@ -8,12 +8,15 @@ Both are written in ActionScript 3. Potlatch 2.0 additionally uses the Flex fram
 
 === What you'll need ===
 
-* OSM Rails port installed on your local machine
-* Flex SDK - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
+* Flex SDK - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux) (Use version 3 and NOT version 4 as there is a compatibility issue)
 * AS3 docs - http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
 * Flash debug player - http://www.adobe.com/support/flashplayer/downloads.html
 * Basically you might as well just sell your soul to Adobe
 
+You'll only need OSM Rails port installed on your local machine if you are doing hard-core 
+server-communication coding, but if generally you can use the dev server at api06.dev.openstreetmap.org
+for development and testing.
+
 === How to compile and run ===
 
 Compiling Potlatch 2:
@@ -50,17 +53,30 @@ of a much larger swf file.. but we're developing so that doesn't matter!).
 * compile 1 
   - when using fcsh recompile the first command
 
+* compile 1
+  - type it again to compile again. You'll really wish that up-arrow,enter 
+    worked, but Adobe is going laughing at you RIGHT NOW.
 
 Running:
 
-* Move everything from the resources/ directory into the same directory as the SWF
-* Open halcyon.html or potlatch2.html in your browser
+* Flash security model sucks. If you want to use internet resource (e.g. map calls to the dev
+  server) the binary must have been served from "teh internets". Run resources/server.rb to launch a local 
+  server, then go to http://localhost:3333/potlatch2.html to get started (or if you're already running e.g. 
+  Apache locally, feel free to use that instead.
+  
+* If you are doing offline development, you will need a rails_port install. You 
+  will need to add an OAuth application by going to 
+  http://rails-port.local/user/<username>/oauth_clients/new
+  Enter the following details (assuming the above point):
+  * Name (Required): Potlatch2 (local)
+  * Main Application URL (Required): http://localhost:3333/resources/potlatch2.html
+  And then update resources/potlatch2.html replacing the domains.
 
 === Some other stuff you might need to know ===
 
-* The as3yaml library has been patched a bit to actually make it work. It will nonetheless spit out 300 warnings on Flex SDK 3.3.
 * Flex compiler runs at about the speed of a tortoise soaked in molasses which happens also to be dead.
-
+* Running the debug player helps when coding, since it'll pop up the runtime errors. You don't see them
+  with the normal player.
 
 Richard Fairhurst
 richard@systemeD.net