Make sure Importers notice POI nodes
[potlatch2.git] / README.txt
index d740d27..45444d3 100644 (file)
@@ -6,30 +6,69 @@ 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) (Use version 3 and NOT version 4 as there is a compatibility issue)
+* Flex SDK 4.5
+** Product page: http://www.adobe.com/products/flex/ 
+** Flex 4.5 Download page: http://opensource.adobe.com/wiki/display/flexsdk/Download+Flex+4.5 (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
+* Ant
+
+If you happen to have Adobe Flex Builder 3/Flash Builder 4, you can create a project and import files into it. 
+See http://wiki.openstreetmap.org/wiki/Potlatch_2/Developer_Documentation for details.
 
 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:
 
-The following command will compile potlatch2 in optimized configuration
+1) Copy the properties template file
+  cp build.properties.template build.properties
+  
+2) Edit the FLEX_HOME variable in build.properties  
+ eg, FLEX_HOME=c:/flex_sdk/4.5.0.20967
+3) ant
+
+The following command will compile potlatch2 in debug configuration
 The result is put at resources/potlatch2.swf
 
-* mxmlc potlatch2.mxml
+* ant
 
+The following command will compile potlatch2 in release configuration
+
+* ant release
 
 Compiling Halcyon as standalone viewer:
 
-* mxmlc halcyon_viewer.as
+* ant halcyon
+
+You can create class documentation (in resources/docs) using asdoc
+
+* ant docs
+
+You can create and run the unit tests (not that there are that many) using flexunit
+
+* ant test
+
+For those that don't need I8n, the following give a much speedier build as it skips the all the language translation build steps.
+As an extra bonus, this uses much less memory and you may get away without needing to tell ant to use more memory (see below).
+
+* ant debug-no-locales
+or
+* ant release-no-locales
+
+If you're using Mac OS X, you may need to tell ant to use more memory, by
+typing export ANT_OPTS="-Xms768m -Xmx1024m -XX:MaxPermSize=512m" 
+beforehand (you can put this in your .profile).
 
 
 Compiling during development:
@@ -55,14 +94,23 @@ of a much larger swf file.. but we're developing so that doesn't matter!).
 
 * 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.
+    worked, but Adobe is laughing at you RIGHT NOW.
+
+* rlwrap
+  - if you have it on your system (e.g. linux), rlwrap is a godsend. Launch
+    fcsh with 'rlwrap path/to/fcsh' and up arrows will work, even persistantly
+    across one fcsh session to the next.
 
 Running:
 
 * 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.
+  Apache locally, feel free to use that instead.)
+  
+  Alternatively, you can update your global Flash security settings to "always trust files" in your local dev area:
+  http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04.html
+  Then you can run the swf file directly.
   
 * If you are doing offline development, you will need a rails_port install. You 
   will need to add an OAuth application by going to 
@@ -77,7 +125,7 @@ Running:
 * 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