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 * Ant
  18
  19 ***Do not use FlexSDK <= 3.3 or > 4***. There are compatibility errors with version 4, and 3.3
  20 and earlier have this bug: http://bugs.adobe.com/jira/browse/SDK-16705 which is a major issue for the
  21 tag editors.
  22
  23 You'll only need OSM Rails port installed on your local machine if you are doing hard-core
  24 server-communication coding, but if generally you can use the dev server at api06.dev.openstreetmap.org
  25 for development and testing.
  26
  27
  28 === How to compile and run ===
  29
  30 Compiling Potlatch 2:
  31
  32 Before you start, copy the properties template file, and edit the FLEX_HOME variable
  33   cp build.properties.template build.properties
  34
  35 The following command will compile potlatch2 in debug configuration
  36 The result is put at resources/potlatch2.swf
  37
  38 * ant
  39
  40 The following command will compile potlatch2 in release configuration
  41
  42 * ant release
  43
  44 Compiling Halcyon as standalone viewer:
  45
  46 * mxmlc halcyon_viewer.as
  47
  48 If you're using Mac OS X, you may need to tell ant to use more memory, by
  49 typing export ANT_OPTS=-Xmx500M beforehand (you can put this in your .profile).
  50
  51
  52 Compiling during development:
  53
  54 Compiling optimized versions from scratch takes a _long_ time. There are
  55 several ways to make it faster during development and also add useful
  56 debug stack traces and enable the commandline debugger (at the expense
  57 of a much larger swf file.. but we're developing so that doesn't matter!).
  58
  59 * fcsh
  60   - launches the Flex Compiler SHell -- stops the compiler having to
  61     bootstrap itself each time you invoke it. You don't /need/ this, but it
  62     does make things slightly faster (about a second a shot for me)
  63
  64 * mxmlc -load-config+=debug-config.xml potlatch2.mxml
  65   - compile potlatch2 in debug configuration -- build is incremental so you
  66     can run it again and mxmlc will only compile changes. Output has debug
  67     enabled along with decent stack traces.
  68     (you can substitute halcyon_viewer.as in the above to compile that)
  69
  70 * compile 1
  71   - when using fcsh recompile the first command
  72
  73 * compile 1
  74   - type it again to compile again. You'll really wish that up-arrow,enter
  75     worked, but Adobe is laughing at you RIGHT NOW.
  76
  77 * rlwrap
  78   - if you have it on your system (e.g. linux), rlwrap is a godsend. Launch
  79     fcsh with 'rlwrap path/to/fcsh' and up arrows will work, even persistantly
  80     across one fcsh session to the next.
  81
  82 Running:
  83
  84 * Flash security model sucks. If you want to use internet resource (e.g. map calls to the dev
  85   server) the binary must have been served from "teh internets". Run resources/server.rb to launch a local
  86   server, then go to http://localhost:3333/potlatch2.html to get started (or if you're already running e.g.
  87   Apache locally, feel free to use that instead.
  88
  89 * If you are doing offline development, you will need a rails_port install. You
  90   will need to add an OAuth application by going to
  91   http://rails-port.local/user/<username>/oauth_clients/new
  92   Enter the following details (assuming the above point):
  93   * Name (Required): Potlatch2 (local)
  94   * Main Application URL (Required): http://localhost:3333/resources/potlatch2.html
  95   And then update resources/potlatch2.html replacing the domains.
  96
  97 === Some other stuff you might need to know ===
  98
  99 * Flex compiler runs at about the speed of a tortoise soaked in molasses which happens also to be dead.
 100 * Running the debug player helps when coding, since it'll pop up the runtime errors. You don't see them
 101   with the normal player.
 102
 103 Richard Fairhurst
 104 richard@systemeD.net
 105
 106 Dave Stubbs
 107 osm@randomjunk.co.uk
 108