Merge branch 'master' of https://github.com/openfl/lime

README.md

@@ -38,7 +38,15 @@ Installation
 
 First install the latest version of [Haxe](http://www.haxe.org/download).
 
-Next, until the new version of Lime is released, you can download the current [development build](http://www.openfl.org/builds/lime), and install using:
+The current version of Lime has not been released on haxelib, yet, so please install the latest [development build](http://www.openfl.org/builds/lime).
+
+
+Development Builds
+==================
+
+When there are changes, Lime is built nightly. Builds are available for download [here](http://www.openfl.org/builds/lime).
+
+To install a development build, use the "haxelib local" command:
 
     haxelib local filename.zip
 
@@ -54,10 +62,14 @@ Tell haxelib where your development copy of Lime is installed:
 
     haxelib dev lime lime
 
-If Aether is installed, you can build the binaries using "aether rebuild":
+You can build the binaries using "lime rebuild":
 
-    aether rebuild lime windows
-    aether rebuild lime linux -64 -release -clean
+    lime rebuild lime windows
+    lime rebuild lime linux -64 -release -clean
+
+If you make modifications to the tools, you can rebuild them like this:
+
+    lime rebuild tools
 
 On a Windows machine, you should have Microsoft Visual Studio C++ (Express is just fine) installed. You will need Xcode on a Mac. To build on a Linux machine, you may need the following packages (or similar):
 
@@ -73,9 +85,9 @@ Sample
 
 You can build a sample Lime project with the following commands:
 
-    aether create lime:HelloWorld
+    lime create lime:HelloWorld
     cd HelloWorld
-    aether test neko
+    lime test neko
 
 You can also list other projects that are available using "aether create lime".
 
@@ -85,11 +97,35 @@ Targets
 
 Lime currently supports the following targets:
 
-    aether test windows
-    aether test mac
-    aether test linux
-    aether test neko
-    aether test html5
-    aether test flash
+    lime test windows
+    lime test mac
+    lime test linux
+    lime test neko
+    lime test html5
+    lime test flash
 
-Native builds must be built on the same operating system as the target. As supported in other versions of Lime, additional platforms (iOS, Android, BlackBerry, Tizen) will be restored in the near future.
+Native builds must be built on the same operating system as the target. As supported in Lime legacy, additional platforms (iOS, Android, BlackBerry, Tizen) will be restored in the near future.
+
+
+Lime "Legacy"
+=============
+
+OpenFL uses older Lime binaries, which are not used in the current version of Lime. These older binaries are derived from shared source within the NME repository, while the newer code has been rewritten to better suit the goals of the project.
+
+In order to rebuild Lime "legacy", you should follow the directions above for building from the source. You will also need additional dependencies:
+
+    git clone https://github.com/haxenme/nme
+    git clone https://github.com/haxenme/nme-dev
+    git clone https://github.com/haxefoundation/hxcpp
+    
+    haxelib dev nme nme
+    haxelib dev nme-dev nme-dev
+    haxelib dev hxcpp hxcpp
+    
+    cd nme-dev/project
+    neko build.n
+    
+    lime rebuild hxcpp windows
+    lime rebuild windows -Dlegacy
+
+You can substitute "windows" for another available target. If you would like to use Lime from the source, but do not need to modify the content of the legacy binaries, it is much easier to download a current development build, and copy the "legacy" folder into your source checkout. Otherwise, the above steps should help.