source: subversion/applications/editors/potlatch2/README.txt @ 18190

Last change on this file since 18190 was 18087, checked in by richard, 10 years ago

update README for Yahoo! component

File size: 2.4 KB
Line 
1== Halcyon and Potlatch 2.0 - ActionScript 3 renderer and editor ==
2
3Potlatch 2.0 is the new version of the OpenStreetMap online editor.
4
5Halcyon 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
7Both 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* Yahoo! Maps API - http://developer.yahoo.com/flash/maps/
17  (copy the .swc to your Flex SDK frameworks/libs folder)
18
19=== How to compile and run ===
20
21Compiling Potlatch 2:
22
23The following command will compile potlatch2 in optimized configuration
24The result is put at resources/potlatch2.swf
25
26* mxmlc potlatch2.mxml
27
28
29Compiling Halcyon as standalone viewer:
30
31* mxmlc halcyon_viewer.as
32
33
34Compiling during development:
35
36Compiling optimized versions from scratch takes a _long_ time. There are
37several ways to make it faster during development and also add useful
38debug stack traces and enable the commandline debugger (at the expense
39of a much larger swf file.. but we're developing so that doesn't matter!).
40
41* fcsh
42  - launches the Flex Compiler SHell -- stops the compiler having to
43    bootstrap itself each time you invoke it. You don't /need/ this, but it
44    does make things slightly faster (about a second a shot for me)
45
46* mxmlc -load-config+=debug-config.xml potlatch2.mxml
47  - compile potlatch2 in debug configuration -- build is incremental so you
48    can run it again and mxmlc will only compile changes. Output has debug
49    enabled along with decent stack traces.
50    (you can substitute halcyon_viewer.as in the above to compile that)
51
52* compile 1
53  - when using fcsh recompile the first command
54
55
56Running:
57
58* Move everything from the resources/ directory into the same directory as the SWF
59* Open halcyon.html or potlatch2.html in your browser
60
61=== Some other stuff you might need to know ===
62
63* Flex compiler runs at about the speed of a tortoise soaked in molasses which happens also to be dead.
64
65
66Richard Fairhurst
67richard@systemeD.net
68
69Dave Stubbs
70osm@randomjunk.co.uk
71
Note: See TracBrowser for help on using the repository browser.