build configs and use libraries rather than include source trees for externals
[potlatch2.git] / README.txt
index 58f1c29..33e3f3a 100644 (file)
@@ -1,8 +1,10 @@
-== Halcyon - ActionScript 3 renderer for Potlatch 2.0 ==
+== Halcyon and Potlatch 2.0 - ActionScript 3 renderer and editor ==
 
-Here's some embryonic unfinished stuff to play with.
+Potlatch 2.0 is the new version of the OpenStreetMap online editor.
 
-This is a live OSM renderer written in AS3 which will one day grow into a beautiful map editor. It's rules-based (like, say, Mapnik) and does dotted lines, text on a path, casing, icons for POIs, all of that.
+Halcyon is its rendering engine. It's rules-based (like, say, Mapnik) and does dotted lines, text on a path, casing, icons for POIs, all of that.
+
+Both are written in ActionScript 3. Potlatch 2.0 additionally uses the Flex framework.
 
 === What you'll need ===
 
@@ -14,24 +16,55 @@ This is a live OSM renderer written in AS3 which will one day grow into a beauti
 
 === How to compile and run ===
 
-Compiling:
+Compiling Potlatch 2:
+
+The following command will compile potlatch2 in optimized configuration
+The result is put at resources/potlatch2.swf
+
+* mxmlc potlatch2.mxml
+
+
+Compiling Halcyon as standalone viewer:
+
+* mxmlc halcyon_viewer.as
+
+
+Compiling during development:
+
+Compiling optimized versions from scratch takes a _long_ time. There are
+several ways to make it faster during development and also add useful
+debug stack traces and enable the commandline debugger (at the expense
+of a much larger swf file.. but we're developing so that doesn't matter!).
+
 * fcsh
-  - launches the Flex Compiler SHell
-* mxmlc -managers=flash.fonts.AFEFontManager -output=/path/to/halcyon.swf /path/to/halcyon.mxml 
-  - compile for the first time
+  - launches the Flex Compiler SHell -- stops the compiler having to
+    bootstrap itself each time you invoke it. You don't /need/ this, but it
+    does make things slightly faster (about a second a shot for me)
+
+* mxmlc -load-config+=debug-config.xml potlatch2.mxml
+  - compile potlatch2 in debug configuration -- build is incremental so you
+    can run it again and mxmlc will only compile changes. Output has debug
+    enabled along with decent stack traces.
+    (you can substitute halcyon_viewer.as in the above to compile that)
+
 * compile 1 
-  - compile each subsequent time (_much_ faster than using mxmlc every time)
+  - when using fcsh recompile the first command
+
 
 Running:
-* Make sure test.yaml and icons/ are in the same directory as halcyon.swf
-* Open halcyon.swf in your browser
+
+* Move everything from the resources/ directory into the same directory as the SWF
+* Open halcyon.html or potlatch2.html in your browser
 
 === Some other stuff you might need to know ===
 
-* The as3yaml library has been patched a bit to actually make it work.
-* The stuff about -managers=flash.fonts.AFEFontManager is probably only required on OS X.
+* 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.
 
 
 Richard Fairhurst
 richard@systemeD.net
+
+Dave Stubbs
+osm@randomjunk.co.uk
+