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

Last change on this file since 19846 was 18557, checked in by richard, 10 years ago

clearly the Yahoo map should be in the lib folder Richard you idiot

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