You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by jo...@apache.org on 2014/04/24 18:05:44 UTC
[12/50] [abbrv] git commit: [flex-falcon] [refs/heads/maven] - add
notice files required for releases
add notice files required for releases
Project: http://git-wip-us.apache.org/repos/asf/flex-falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-falcon/commit/63e66dc5
Tree: http://git-wip-us.apache.org/repos/asf/flex-falcon/tree/63e66dc5
Diff: http://git-wip-us.apache.org/repos/asf/flex-falcon/diff/63e66dc5
Branch: refs/heads/maven
Commit: 63e66dc587df09c250df9d4bf9e1ee4d6369dfb1
Parents: 14a382c
Author: Alex Harui <ah...@apache.org>
Authored: Mon Apr 7 14:59:29 2014 -0700
Committer: Alex Harui <ah...@apache.org>
Committed: Mon Apr 7 14:59:29 2014 -0700
----------------------------------------------------------------------
LICENSE | 203 ++++++++++++++++++++++++++++++++++++++
NOTICE | 9 ++
NOTICE_JX | 5 +
README | 266 ++++++++++++++++++++++++++++++++++++++++++++++++--
README_JX | 124 +++++++++++++++++++++++
RELEASE_NOTES | 23 +++++
RELEASE_NOTES_JX | 19 ++++
build.xml | 16 ++-
8 files changed, 654 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/LICENSE
----------------------------------------------------------------------
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..6b0b127
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,203 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/NOTICE
----------------------------------------------------------------------
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..3144d36
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,9 @@
+Apache Flex Compiler
+Copyright 2014 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+The Initial Developer of the Original Code, known as Adobe ASC 2.0,
+is Adobe Systems Incorporated (http://www.adobe.com/).
+ Copyright 2003 - 2012 Adobe Systems Incorporated. All Rights Reserved.
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/NOTICE_JX
----------------------------------------------------------------------
diff --git a/NOTICE_JX b/NOTICE_JX
new file mode 100644
index 0000000..1e17421
--- /dev/null
+++ b/NOTICE_JX
@@ -0,0 +1,5 @@
+Apache Flex Cross-Compiler
+Copyright 2014 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/README
----------------------------------------------------------------------
diff --git a/README b/README
index b874c16..6702de2 100644
--- a/README
+++ b/README
@@ -1,13 +1,267 @@
Apache Flex Compiler
====================
-Before trying to build Falcon, you must:
+ This Apache Flex Compiler is also known as the 'Falcon' compiler. It is
+ the next-generation replacement to the MXMLC compiler that is currently
+ bundled with the Apache Flex SDK and is based on the Adobe ASC2.0 code base
+ donated to Apache by Adobe Systems Inc.
-1. Build the the "develop" branch of the SDK in the GIT repository at https://git-wip-us.apache.org/repos/asf/flex-falcon.git by doing 'ant main'.
-See the README there for instructions.
+ For detailed information about Apache Flex please visit
+ http://flex.apache.org/
-2. Set the environment variables JAVA_HOME, ANT_HOME, PLAYERGLOBAL_HOME, and FLASHPLAYER_DEBUGGER as when building the SDK.
+ This compiler may eventually replace MXMLC in the Apache Flex SDK, but is
+ also being used as the compiler for the Apache FlexJS SDK. FlexJS is a
+ next-generation SDK that allows the developer to leverage MXML and ActionScript
+ to build applications that not only run as a SWF, but can also be cross-compiled
+ to JavaScript and run natively in a browser or anywhere JavaScript runs.
-3. Set the environment variable JFLEX_JAR to point to the JAR file for JFlex 1.4.3.
+Getting the latest sources via git
+==================================
-Before running unit-, functional- or feature-tests you need to create a unittest.properties file ( template is found here compiler.tests/template-unittest.properties ).
\ No newline at end of file
+ Getting the source code is the recommended way to get the Apache Flex Compiler.
+ We also offer an automated installer along with binary distributions on our
+ website at http://flex.apache.org/.
+
+ You can always checkout the latest source via git using the following
+ command:
+
+ git clone https://git-wip-us.apache.org/repos/asf/flex-falcon.git falcon
+ cd falcon
+ git checkout develop
+
+ The Apache Flex Compiler also requires code from other Apache Flex git
+ repositories or an Apache Flex SDK. To get the latest source via git
+ for the Apache Flex SDK use the following command:
+
+ git clone https://git-wip-us.apache.org/repos/asf/flex-sdk.git sdk
+ cd sdk
+ git checkout develop
+
+ The Apache Flex SDK requires the Text Layout Framework repository which
+ you can get as follows:
+
+ git clone https://git-wip-us.apache.org/repos/asf/flex-tlf.git tlf
+ cd tlf
+ git checkout develop
+
+ To use an Apache Flex SDK, install an Apache Flex SDK on your computer and
+ follow the instructions in 'Install Prerequisites'.
+
+Building the Apache Flex Compiler
+=================================
+
+ The Apache Flex Compiler is a large project. It requires some build tools
+ which must be installed prior to building the compiler and it depends on
+ some external software which are downloaded as part of the build process.
+ Some of these have different licenses. See the Software Dependencies section
+ for more information on the external software dependencies.
+
+ From Apache's perspective, the JFlex jar has an excluded license so they can
+ not be bundled with the Apache Flex binaries.
+ It must be installed prior to building Apache Flex.
+
+ Linux support is currently experimental and while it is possible to compile
+ the SDK it has not been fully tested so you may run into issues.
+
+Install Prerequisites
+---------------------
+
+ Before building the Apache Flex Compiler you must install the following software
+ and set the corresponding environment variables using absolute file paths.
+ Relative file paths will result in build errors.
+
+ ==================================================================================
+ SOFTWARE ENVIRONMENT VARIABLE (absolute paths)
+ ==================================================================================
+
+ Java SDK 1.6 or greater (*1) JAVA_HOME
+ (for Java 1.7 see note at (*2))
+
+ Ant 1.7.1 or greater (*1) ANT_HOME
+ (for Java 1.7 see note at (*2))
+
+ Adobe AIR Integration Kit (*3) AIR_HOME
+
+ Adobe Flash Player Content Debugger (*4) FLASHPLAYER_DEBUGGER
+
+ Adobe Flash Player playerglobal swcs (*5) PLAYERGLOBAL_HOME
+
+ JFlex jar (*6) JFLEX_JAR
+
+ Adobe Flex SDK or repository FLEX_HOME
+
+ ==================================================================================
+
+ *1) The bin directories for ANT_HOME and JAVA_HOME should be added to your
+ PATH.
+
+ On Windows, set PATH to
+
+ PATH=%PATH%;%ANT_HOME%\bin;%JAVA_HOME%\bin
+
+ On the Mac (bash), set PATH to
+
+ export PATH="$PATH:$ANT_HOME/bin:$JAVA_HOME/bin"
+
+ On Linux make sure you path include ANT_HOME and JAVA_HOME.
+
+ *2) If you are using Java SDK 1.7 or greater on a Mac you must use Ant 1.8
+ or greater. If you use Java 1.7 with Ant 1.7, ant reports the java
+ version as 1.6 so the JVM args for the data model (-d32/-d64) will not
+ be set correctly and you will get compile errors.
+
+ *3) The Adobe AIR integration kit for Windows can be downloaded from:
+ http://airdownload.adobe.com/air/win/download/4.0/AdobeAIRSDK.zip
+
+ The Adobe AIR integration kit for Mac can be downloaded from:
+ http://airdownload.adobe.com/air/mac/download/4.0/AdobeAIRSDK.tbz2
+
+ The Adobe AIR integration kit for Linux can be downloaded from:
+ http://airdownload.adobe.com/air/lin/download/2.6/AdobeAIRSDK.tbz2
+
+ This version of Apache Flex was certified for use with AIR 4.0, and
+ should be compatible with other versions of AIR newer than 3.1. However
+ it hasn't been fully tested on AIR 3.2, 3.3, 3.5, 3.6 or 3.7.
+
+ Download the AIR SDK for your platform and unzip it. Set AIR_HOME to the
+ absolute path of the AIR SDK directory.
+
+ *4) The Adobe Flash Player content debuggers can be found here:
+ http://www.adobe.com/support/flashplayer/downloads.html
+
+ This version of Apache Flex was certified for use with Adobe Flash
+ Player 11.1, and is compatible with versions 10.2 through 13.0. It has
+ been tested with versions 11.1, 11.7, 11.8, 11.9 and 12.0 on Windows
+ and Mac. It has been compiled against other Adobe Flash Player versions
+ but has not been fully tested. It has not been fully tested on Linux.
+
+ On Windows, set FLASHPLAYER_DEBUGGER to the absolute path including the
+ filename of the FlashPlayerDebugger.exe. Note the filename of flash
+ player debugger maybe different.
+ e.g. C:\MyPath\FlashPlayerDebugger.exe
+
+ On the Mac, set FLASHPLAYER_DEBUGGER to the absolute path of
+ Flash Player Debugger.app/Contents/MacOS/Flash Player Debugger
+
+ On Linux, set FLASHPLAYER_DEBUGGER to the absolute path of
+ flashplayerdebugger
+
+ *5) The Adobe Flash Player playerglobal.swc for 11.1 can be downloaded from:
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc
+
+ Use URL above to download playerglobal11_1.swc. Create the directory,
+ player/11.1 and copy playerglobal11_1.swc to
+ player/11.1/playerglobal.swc.
+
+ Set PLAYERGLOBAL_HOME to the absolute path of the player directory (not
+ including the version subdirectory). The target-player option controls
+ which PLAYERGLOBAL_HOME subdirectory is used.
+
+ Other more recent versions of Adobe Flash Player playerglobal.swc can be
+ downloaded from:
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_2.swc
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_3.swc
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_4.swc
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_5.swc
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_6.swc
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_7.swc
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_8.swc
+ http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_9.swc
+ http://download.macromedia.com/get/flashplayer/updaters/12/playerglobal12_0.swc
+
+ These can be used with Apache Flex but not all have not been fully
+ tested.
+
+ *6) The JFlex jar can be downloaded from:
+ http://jflex.de/download.html
+
+ Set JFLEX_JAR to the absolute path of JFlex.jar
+ e.g JFLEX_JAR=/path/to/jflex-1.4.3/lib/JFlex.jar
+
+
+Software Dependencies
+---------------------
+
+ The Apache Flex Compiler uses third-party code that will be downloaded as
+ part of the build.
+
+ The Apache Version 2.0 license is in the LICENSE file.
+
+ The following dependencies have licenses which are, or are compatible with,
+ the Apache Version 2.0 license. You will not be prompted to acknowledge the
+ download. Most of the jars are installed in lib/external when installed
+ into an Apache Flex SDK and the lib folder in the repository working copy.
+
+ antler - http://antlr3.org/download/antlr-3.3-complete.jar
+ commons-cli - http://archive.apache.org/dist/commons/cli/binaries/commons-cli-1.2-bin.tar.gz
+ commons-io - http://archive.apache.org/dist/commons/io/binaries/commons-io-2.0.1.tar.gz
+ guava - http://search.maven.org/remotecontent?filepath=com/google/guava/guava/15.0/guava-15.0.jar
+ jburg - http://downloads.sourceforge.net/project/jburg/jburg-1.10.1.tar.gz
+ lzma - http://www.java2s.com/Code/JarDownload/lzma/lzma-9.20.jar.zip
+
+
+Using the Binary Distribution
+-----------------------------
+
+ The binary distribution is intended to be installed into an existing Apache Flex
+ SDK or Apache FlexJS SDK.
+
+ There is an Apache Ant script in the binary distribution that will copy the
+ files into the right places.
+
+ To run it, use:
+ ant -f installer.xml -DFLEX_HOME=<path to Flex or FlexJS SDK
+
+ The script does not check the FLEX_HOME environment variable as that often
+ points to your primary Flex SDK.
+
+ If you expand the binary distribution into the "in" folder of an Apache Flex or
+ FlexJS SDK, the installer.xml script should find FLEX_HOME automatically.
+
+ Another option is to use the InstallApacheFlex (version 3.0 or higher).
+
+Building the Source in the Source Distribution
+----------------------------------------------
+
+ When you have all the prerequisites in place and the environment variables
+ set (see Install Prerequisites above), use
+
+ cd <falcon.dir>
+ ant main (or just ant since the default target is main)
+
+ to download the thirdparty dependencies and build the source. Since the
+ third-party dependencies take a little while to download and they don't
+ change very often, they are not cleaned with the regular clean target.
+
+ To clean the build, of everything other than the downloaded third-party
+ dependencies use
+
+ ant clean
+
+ To clean the build, of everything, including the downloaded third-party
+ dependencies use
+
+ ant wipe (which is just thirdparty-clean followed by clean)
+
+ To generate a source distribution package and a binary distribution package
+ use
+
+ ant -Dbuild.number=<YYYYMMDD> -Dbuild.noprompt= release
+
+ The packages can be found in the "out" subdirectory.
+
+ To get a brief listing of all the targets type
+
+ ant -projecthelp
+
+Running Tests
+---------------------
+
+Before running unit-, functional- or feature-tests you need to create a unittest.properties file ( template is found here compiler.tests/template-unittest.properties ).
+
+
+
+Thanks for using Apache Flex. Enjoy!
+
+ The Apache Flex Project
+ <http://flex.apache.org>
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/README_JX
----------------------------------------------------------------------
diff --git a/README_JX b/README_JX
new file mode 100644
index 0000000..758ece5
--- /dev/null
+++ b/README_JX
@@ -0,0 +1,124 @@
+Apache Flex Cross-Compiler
+====================
+
+ This Apache Flex Cross-Compiler is also known as the 'FalconJX' compiler. It
+ leverages code from the Apache Flex 'Falcon' Compiler but outputs JavaScript
+ instead of a SWF.
+
+ For detailed information about Apache Flex please visit
+ http://flex.apache.org/
+
+ This compiler is used in the Apache FlexJS SDK. FlexJS is a
+ next-generation SDK that allows the developer to leverage MXML and ActionScript
+ to build applications that not only run as a SWF, but can also be cross-compiled
+ to JavaScript and run natively in a browser or anywhere JavaScript runs.
+
+Getting the latest sources via git
+==================================
+
+ Getting the source code is the recommended way to get the Apache Flex Cross-Compiler.
+ We also offer an automated installer along with binary distributions on our
+ website at http://flex.apache.org/.
+
+ You can always checkout the latest source via git using the following
+ command:
+
+ git clone https://git-wip-us.apache.org/repos/asf/flex-falcon.git falcon
+ cd falcon
+ git checkout develop
+
+ See the main README for instructions on setting up and building the Apache
+ Flex 'Falcon' cross-compiler.
+
+Building the Apache Flex Cross-Compiler
+=======================================
+
+ The Apache Flex Cross-Compiler is a large project. It requires that the
+ Apache Flex Compiler has been built. See the main README for instructions.
+
+ Linux support is currently experimental and while it is possible to compile
+ the SDK it has not been fully tested so you may run into issues.
+
+Software Dependencies
+---------------------
+
+ The Apache Flex Cross-Compiler uses third-party code that will be downloaded as
+ part of the build.
+
+ The Apache Version 2.0 license is in the LICENSE file.
+
+ The following dependencies have licenses which are, or are compatible with,
+ the Apache Version 2.0 license. You will not be prompted to acknowledge the
+ download. Most of the jars are installed in lib/external when installed
+ into an Apache Flex SDK and the lib folder in the repository working copy.
+
+ Google Closure Compiler - http://dl.google.com/closure-compiler/compiler-latest.zip
+ commons-io - http://archive.apache.org/dist/commons/io/binaries/commons-io-2.0.1.tar.gz
+
+
+Using the Binary Distribution
+-----------------------------
+
+ The binary distribution is intended to be installed into an existing
+ Apache FlexJS SDK.
+
+ There is an Apache Ant script in the binary distribution that will copy the
+ files into the right places.
+
+ To run it, use:
+ ant -f installer.xml -DFLEX_HOME=<path to FlexJS SDK
+
+ The script does not check the FLEX_HOME environment variable as that often
+ points to your primary Flex SDK.
+
+ If you expand the binary distribution into the "in" folder of an Apache
+ FlexJS SDK, the installer.xml script should find FLEX_HOME automatically.
+
+ Another option is to use the InstallApacheFlex (version 3.0 or higher).
+
+Building the Source in the Source Distribution
+----------------------------------------------
+
+ When you have all the prerequisites in place and the environment variables
+ set (see Install Prerequisites above), use
+
+ cd <falcon.dir>
+ ant all (or just ant since the default target is main)
+
+ to download the thirdparty dependencies and build the source. Since the
+ third-party dependencies take a little while to download and they don't
+ change very often, they are not cleaned with the regular clean target.
+
+ To clean the build, of everything other than the downloaded third-party
+ dependencies use
+
+ ant clean-all
+
+ To clean the build, of everything, including the downloaded third-party
+ dependencies use
+
+ ant wipe-all (which is just thirdparty-clean followed by clean)
+
+ To generate a source distribution package and a binary distribution package
+ use
+
+ ant -Dbuild.number=<YYYYMMDD> -Dbuild.noprompt= release
+
+ The packages can be found in the "out" subdirectory.
+
+ To get a brief listing of all the targets type
+
+ ant -projecthelp
+
+
+Running Tests
+---------------------
+
+Before running unit-, functional- or feature-tests you need to create a unittest.properties file ( template is found here compiler.tests/template-unittest.properties ).
+
+
+
+Thanks for using Apache Flex. Enjoy!
+
+ The Apache Flex Project
+ <http://flex.apache.org>
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/RELEASE_NOTES
----------------------------------------------------------------------
diff --git a/RELEASE_NOTES b/RELEASE_NOTES
new file mode 100644
index 0000000..daa471c
--- /dev/null
+++ b/RELEASE_NOTES
@@ -0,0 +1,23 @@
+Apache Flex 'Falcon' Compiler 0.0.1
+=================
+
+Apache Flex 'Falcon' Compiler 0.0.1 is the initial release of a next-generation
+compiler intended to someday replace the MXMLC in Apache Flex SDKs, and is the
+compiler for Apache FlexJS SDKs. It is based on the Adobe ASC2.0 compiler but
+officially supports MXML compilation and includes some bug fixes.
+
+Known Issues
+_____________
+
+Adobe Flash Builder Integration
+
+The Apache Flex Falcon compiler should work in Adobe Flash Builder 4.7, but does
+not support incremental compilation and may compile the project even if nothing
+has changed.
+
+Please report new issues to our bugbase at:
+
+ https://issues.apache.org/jira/browse/FLEX
+
+ The Apache Flex Project
+ <http://flex.apache.org/>
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/RELEASE_NOTES_JX
----------------------------------------------------------------------
diff --git a/RELEASE_NOTES_JX b/RELEASE_NOTES_JX
new file mode 100644
index 0000000..aa2ec67
--- /dev/null
+++ b/RELEASE_NOTES_JX
@@ -0,0 +1,19 @@
+Apache Flex 'FalconJX' Cross-Compiler 0.0.1
+=================
+
+Apache Flex 'FalconJX' Compiler 0.0.1 is the initial release of a next-generation
+compiler that, instead of creating a SWF or SWC, cross compiles MXML and ActionScript
+to JavaScript. It is intended for use as the cross-compiler for Apache FlexJS SDKs.
+It is an extension of the Apache Flex 'Falcon' Compiler.
+
+Known Issues
+_____________
+
+None at this time.
+
+Please report new issues to our bugbase at:
+
+ https://issues.apache.org/jira/browse/FLEX
+
+ The Apache Flex Project
+ <http://flex.apache.org/>
http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/63e66dc5/build.xml
----------------------------------------------------------------------
diff --git a/build.xml b/build.xml
index e09e471..68f1255 100644
--- a/build.xml
+++ b/build.xml
@@ -210,15 +210,13 @@
<include name="build.xml"/>
<include name="build.properties"/>
<include name="env-template.properties"/>
- <include name="READme"/>
+ <include name="README"/>
+ <include name="LICENSE"/>
+ <include name="NOTICE"/>
<include name="RELEASE_NOTES"/>
<include name="installer.xml"/>
<include name="installer.properties/**"/>
</fileset>
- <fileset dir="${FLEX_SDK_HOME}">
- <include name="LICENSE"/>
- <include name="NOTICE"/>
- </fileset>
</copy>
<!-- compiler -->
@@ -313,6 +311,14 @@
<target name="stage-source-jx"
description="Package jx source files with other falcon files required to build in zip file" >
+ <copy todir="${basedir}/temp" includeEmptyDirs="false">
+ <fileset dir="${basedir}">
+ <include name="README_JX"/>
+ <include name="NOTICE_JX"/>
+ <include name="RELEASE_NOTES_JX"/>
+ </fileset>
+ </copy>
+
<copy todir="${basedir}/temp/compiler.jx" includeEmptyDirs="false">
<fileset dir="${basedir}/compiler.jx">
<include name="**"/>