Move the getConsumer method to the Connection
[potlatch2.git] / README.txt
index cb43cd34df0577eacb6337e9f4ed2656d307b177..02cf2c0265a37da0b5077db97b2e4f9cf3f9d849 100644 (file)
@@ -6,17 +6,24 @@ Halcyon is its rendering engine. It's rules-based (like, say, Mapnik) and does d
 
 Both are written in ActionScript 3. Potlatch 2.0 additionally uses the Flex framework.
 
+Many icons used in halcyon/potlatch2 are based on the awesome CC0-licensed SJJB icons project. http://www.sjjb.co.uk/mapicons/
+
 === What you'll need ===
 
-* Flex SDK - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
+* Flex SDK 3.4 or 3.5 - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
 * 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
 
+***Do not use FlexSDK <= 3.3 or > 4***. There are compatibility errors with version 4, and 3.3
+and earlier have this bug: http://bugs.adobe.com/jira/browse/SDK-16705 which is a major issue for the
+tag editors.
+
 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:
@@ -63,13 +70,21 @@ Running:
   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 ===
 
 * 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