POI stuff
[potlatch2.git] / README.txt
1 == Halcyon - ActionScript 3 renderer for Potlatch 2.0 ==
2
3 Here's some embryonic unfinished stuff to play with.
4
5 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.
6
7 === What you'll need ===
8
9 * OSM Rails port installed on your local machine
10 * Flex SDK - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
11 * AS3 docs - http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
12 * Flash debug player - http://www.adobe.com/support/flashplayer/downloads.html
13 * Basically you might as well just sell your soul to Adobe
14
15 === How to compile and run ===
16
17 Compiling:
18 * fcsh
19   - launches the Flex Compiler SHell
20 * mxmlc -managers=flash.fonts.AFEFontManager -output=/path/to/halcyon.swf /path/to/halcyon.mxml 
21   - compile for the first time
22 * compile 1 
23   - compile each subsequent time (_much_ faster than using mxmlc every time)
24
25 Running:
26 * Make sure test.yaml and icons/ are in the same directory as halcyon.swf
27 * Open halcyon.swf in your browser
28
29 === Some other stuff you might need to know ===
30
31 * The as3yaml library has been patched a bit to actually make it work.
32 * The stuff about -managers=flash.fonts.AFEFontManager is probably only required on OS X.
33 * Flex compiler runs at about the speed of a tortoise soaked in molasses which happens also to be dead.
34
35
36 Richard Fairhurst
37 richard@systemeD.net