Commenting for ASDoc
[potlatch2.git] / README.txt
index 02cf2c0..52c3db8 100644 (file)
@@ -10,10 +10,13 @@ Many icons used in halcyon/potlatch2 are based on the awesome CC0-licensed SJJB
 
 === What you'll need ===
 
-* Flex SDK 3.4 or 3.5 - http://www.adobe.com/products/flex/ (free, OS X/Windows/Linux)
+* Flex SDK 3.4 or 3.5 
+** Product page: http://www.adobe.com/products/flex/ 
+** Flex 3 Download page: http://opensource.adobe.com/wiki/display/flexsdk/Download+Flex+3 (free, OS X/Windows/Linux)
 * AS3 docs - http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
 * Flash debug player - http://www.adobe.com/support/flashplayer/downloads.html
 * Basically you might as well just sell your soul to Adobe
+* Ant
 
 ***Do not use FlexSDK <= 3.3 or > 4***. There are compatibility errors with version 4, and 3.3
 and earlier have this bug: http://bugs.adobe.com/jira/browse/SDK-16705 which is a major issue for the
@@ -28,15 +31,32 @@ for development and testing.
 
 Compiling Potlatch 2:
 
-The following command will compile potlatch2 in optimized configuration
+Before you start, copy the properties template file, and edit the FLEX_HOME variable
+  cp build.properties.template build.properties
+
+The following command will compile potlatch2 in debug configuration
 The result is put at resources/potlatch2.swf
 
-* mxmlc potlatch2.mxml
+* ant
+
+The following command will compile potlatch2 in release configuration
 
+* ant release
 
 Compiling Halcyon as standalone viewer:
 
-* mxmlc halcyon_viewer.as
+* ant halcyon
+
+You can create class documentation (in resources/docs) using asdoc
+
+* ant docs
+
+You can create and run the unit tests (not that there are that many) using flexunit
+
+* ant test
+
+If you're using Mac OS X, you may need to tell ant to use more memory, by
+typing export ANT_OPTS=-Xmx500M beforehand (you can put this in your .profile).
 
 
 Compiling during development:
@@ -62,7 +82,12 @@ of a much larger swf file.. but we're developing so that doesn't matter!).
 
 * compile 1
   - type it again to compile again. You'll really wish that up-arrow,enter 
-    worked, but Adobe is going laughing at you RIGHT NOW.
+    worked, but Adobe is laughing at you RIGHT NOW.
+
+* rlwrap
+  - if you have it on your system (e.g. linux), rlwrap is a godsend. Launch
+    fcsh with 'rlwrap path/to/fcsh' and up arrows will work, even persistantly
+    across one fcsh session to the next.
 
 Running: