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 Many icons used in halcyon/potlatch2 are based on the awesome CC0-licensed SJJB icons project. http://www.sjjb.co.uk/mapicons/
  10
  11 === What you'll need ===
  12
  13 * Flex SDK 3.4 or 3.5 - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
  14 * AS3 docs - http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
  15 * Flash debug player - http://www.adobe.com/support/flashplayer/downloads.html
  16 * Basically you might as well just sell your soul to Adobe
  17
  18 ***Do not use FlexSDK <= 3.3 or > 4***. There are compatibility errors with version 4, and 3.3
  19 and earlier have this bug: http://bugs.adobe.com/jira/browse/SDK-16705 which is a major issue for the
  20 tag editors.
  21
  22 You'll only need OSM Rails port installed on your local machine if you are doing hard-core
  23 server-communication coding, but if generally you can use the dev server at api06.dev.openstreetmap.org
  24 for development and testing.
  25
  26
  27 === How to compile and run ===
  28
  29 Compiling Potlatch 2:
  30
  31 The following command will compile potlatch2 in optimized configuration
  32 The result is put at resources/potlatch2.swf
  33
  34 * mxmlc potlatch2.mxml
  35
  36
  37 Compiling Halcyon as standalone viewer:
  38
  39 * mxmlc halcyon_viewer.as
  40
  41
  42 Compiling during development:
  43
  44 Compiling optimized versions from scratch takes a _long_ time. There are
  45 several ways to make it faster during development and also add useful
  46 debug stack traces and enable the commandline debugger (at the expense
  47 of a much larger swf file.. but we're developing so that doesn't matter!).
  48
  49 * fcsh
  50   - launches the Flex Compiler SHell -- stops the compiler having to
  51     bootstrap itself each time you invoke it. You don't /need/ this, but it
  52     does make things slightly faster (about a second a shot for me)
  53
  54 * mxmlc -load-config+=debug-config.xml potlatch2.mxml
  55   - compile potlatch2 in debug configuration -- build is incremental so you
  56     can run it again and mxmlc will only compile changes. Output has debug
  57     enabled along with decent stack traces.
  58     (you can substitute halcyon_viewer.as in the above to compile that)
  59
  60 * compile 1
  61   - when using fcsh recompile the first command
  62
  63 * compile 1
  64   - type it again to compile again. You'll really wish that up-arrow,enter
  65     worked, but Adobe is going laughing at you RIGHT NOW.
  66
  67 Running:
  68
  69 * Flash security model sucks. If you want to use internet resource (e.g. map calls to the dev
  70   server) the binary must have been served from "teh internets". Run resources/server.rb to launch a local
  71   server, then go to http://localhost:3333/potlatch2.html to get started (or if you're already running e.g.
  72   Apache locally, feel free to use that instead.
  73
  74 * If you are doing offline development, you will need a rails_port install. You
  75   will need to add an OAuth application by going to
  76   http://rails-port.local/user/<username>/oauth_clients/new
  77   Enter the following details (assuming the above point):
  78   * Name (Required): Potlatch2 (local)
  79   * Main Application URL (Required): http://localhost:3333/resources/potlatch2.html
  80   And then update resources/potlatch2.html replacing the domains.
  81
  82 === Some other stuff you might need to know ===
  83
  84 * Flex compiler runs at about the speed of a tortoise soaked in molasses which happens also to be dead.
  85 * Running the debug player helps when coding, since it'll pop up the runtime errors. You don't see them
  86   with the normal player.
  87
  88 Richard Fairhurst
  89 richard@systemeD.net
  90
  91 Dave Stubbs
  92 osm@randomjunk.co.uk
  93