You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by er...@apache.org on 2013/04/09 15:18:41 UTC

git commit: FLEX-33481: [FalconJX] improve README

Updated Branches:
  refs/heads/develop a86993ea4 -> 44c3c633d


FLEX-33481: [FalconJX] improve README

Improved README as per the suggestion of Tigran Najaryan.

Signed-off-by: Erik de Bruin <er...@ixsoftware.nl>


Project: http://git-wip-us.apache.org/repos/asf/flex-falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-falcon/commit/44c3c633
Tree: http://git-wip-us.apache.org/repos/asf/flex-falcon/tree/44c3c633
Diff: http://git-wip-us.apache.org/repos/asf/flex-falcon/diff/44c3c633

Branch: refs/heads/develop
Commit: 44c3c633d72f19f8413c8ce1b3ce06f738bd66b6
Parents: a86993e
Author: Erik de Bruin <er...@ixsoftware.nl>
Authored: Tue Apr 9 15:18:22 2013 +0200
Committer: Erik de Bruin <er...@ixsoftware.nl>
Committed: Tue Apr 9 15:18:22 2013 +0200

----------------------------------------------------------------------
 compiler.jx/README |   65 +++++++++++++++++++++++++++++++++++++++++++---
 1 files changed, 60 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/44c3c633/compiler.jx/README
----------------------------------------------------------------------
diff --git a/compiler.jx/README b/compiler.jx/README
index 15a21e6..3c0beda 100644
--- a/compiler.jx/README
+++ b/compiler.jx/README
@@ -1,7 +1,62 @@
-Apache FalconJx Prototype Cross Compiler
-====================
 
-- This needs to be more detailed.
+Apache FalconJx Prototype Cross Compiler 
+==================== 
 
-- Falcon needs to be built, see it's README
-- A temp folder needs to be created in the compiler.jx/temp
\ No newline at end of file
+Note: steps 1-4 and 7 below describe how to get and build Apache Flex SDK, develop branch. If you already have the the develop branch of SDK skip these steps. 
+
+To get and build FalconJX compiler follow these steps: 
+
+
+1. Create a working directory for Apache Flex ("repo" below). 
+
+2. cd repo 
+
+3. Get bleading-edge of SDK: 
+git clone https://git-wip-us.apache.org/repos/asf/flex-sdk.git sdk 
+cd sdk 
+git checkout develop 
+cd .. 
+
+4. Get TLF 
+git clone https://git-wip-us.apache.org/repos/asf/flex-tlf.git tlf 
+
+5. Get Falcon and switch to develop branch: 
+git clone https://git-wip-us.apache.org/repos/asf/flex-falcon.git falcon 
+cd falcon 
+git checkout develop 
+cd .. 
+
+6. Get ASJS 
+git clone https://git-wip-us.apache.org/repos/asf/flex-asjs.git asjs 
+cd asjs 
+git checkout develop 
+cd .. 
+
+7. Build SDK. Follow instructions in sdk/README, then: 
+cd sdk 
+ant main (Select all default answers when prompted, i.e. just hit ENTER until the build finishes). 
+cd .. 
+
+8. Build Falcon compiler. Follow instructions in falcon/compiler/README, then: 
+
+cd falcon/compiler 
+ant -Dsdk.branch=path-to-repo/sdk 
+cd ../.. 
+
+(Note: the compiler/build.xml assumes Flex SDK is in ../flex-sdk dir, which is not what we have created in step 3 above, so you need to supply correct dir to Ant via sdk.branch parameter). 
+
+
+9. Build FalconJX. 
+
+cd falcon/compiler.jx 
+ant 
+cd ../.. 
+
+
+10. Build ASJS and FlexJSUI.swc: 
+cd asjs 
+ant 
+cd frameworks/as 
+ant
+
+11. create a 'temp' folder in 'compiler.jx'?
\ No newline at end of file