README.txt

   1 == Halcyon and Potlatch 2.0 - ActionScript 3 renderer and editor ==
   2
   3 Potlatch 2.0 is the new version of the OpenStreetMap online editor.
   4
   5 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.
   6
   7 Both are written in ActionScript 3. Potlatch 2.0 additionally uses the Flex framework.
   8
   9 === What you'll need ===
  10
  11 * OSM Rails port installed on your local machine
  12 * Flex SDK - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
  13 * AS3 docs - http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
  14 * Flash debug player - http://www.adobe.com/support/flashplayer/downloads.html
  15 * Basically you might as well just sell your soul to Adobe
  16
  17 === How to compile and run ===
  18
  19 Compiling:
  20
  21 * fcsh
  22   - launches the Flex Compiler SHell
  23
  24 * mxmlc -managers=flash.fonts.AFEFontManager -output=/path/to/halcyon.swf /path/to/halcyon.mxml
  25 * mxmlc -managers=flash.fonts.AFEFontManager -output=/path/to/halcyon_viewer.swf /path/to/halcyon_viewer.as
  26   - compile Potlatch or Halcyon for the first time
  27
  28 * compile 1
  29   - compile each subsequent time (_much_ faster than using mxmlc every time)
  30
  31 * for nice debug reports compile with the mxmlc command:
  32   mxmlc -managers=flash.fonts.AFEFontManager -compiler.debug -compiler.verbose-stacktraces -output=halcyon.swf halcyon.mxml
  33
  34 Running:
  35
  36 * Move everything from the resources/ directory into the same directory as the SWF
  37 * Open halcyon.html or potlatch2.html in your browser
  38
  39 === Some other stuff you might need to know ===
  40
  41 * 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.
  42 * The stuff about -managers=flash.fonts.AFEFontManager is probably only required on OS X.
  43 * Flex compiler runs at about the speed of a tortoise soaked in molasses which happens also to be dead.
  44
  45
  46 Richard Fairhurst
  47 richard@systemeD.net