Update shooting icon to new one from sjjb
[potlatch2.git] / README.txt
index e64a578..b905b9f 100644 (file)
@@ -6,17 +6,25 @@ 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.
 
 
 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 ===
 
 === What you'll need ===
 
-* Flex SDK 3.4 or 3.5 - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
+* Flex SDK 3.4 or 3.5 
+** Product page: http://www.adobe.com/products/flex/ 
+** Flex 3 Download page: http://opensource.adobe.com/wiki/display/flexsdk/Download+Flex+3 (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
 * 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
 
 ***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.
 
 
 ***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.
 
+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.
 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.
@@ -26,15 +34,37 @@ for development and testing.
 
 Compiling Potlatch 2:
 
 
 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/3.5.0.12683
+3) ant
+
+The following command will compile potlatch2 in debug configuration
 The result is put at resources/potlatch2.swf
 
 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:
 
 
 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
+
+If you're using Mac OS X, you may need to tell ant to use more memory, by
+typing export ANT_OPTS=-Xmx500M beforehand (you can put this in your .profile).
 
 
 Compiling during development:
 
 
 Compiling during development:
@@ -60,14 +90,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 
 
 * 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. 
 
 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 
   
 * If you are doing offline development, you will need a rails_port install. You 
   will need to add an OAuth application by going to 
@@ -82,7 +121,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.
 * 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
 
 Richard Fairhurst
 richard@systemeD.net