Repository: flex-asjs Updated Branches: refs/heads/develop fc9532b21 -> da0b44d6a
add notice files required for releases Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/31ce1778 Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/31ce1778 Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/31ce1778 Branch: refs/heads/develop Commit: 31ce1778dc1ec9e5700432523fcae325de7dad45 Parents: fc9532b Author: Alex Harui <aha...@apache.org> Authored: Mon Apr 7 14:55:43 2014 -0700 Committer: Alex Harui <aha...@apache.org> Committed: Mon Apr 7 14:55:43 2014 -0700 ---------------------------------------------------------------------- LICENSE | 203 +++++++++++++++++++++++++++++++++++++++++++++++++ NOTICE | 5 ++ READme | 218 +++++++++++++++++++++++++++++++++++++++++++++++++++-- RELEASE_NOTES | 4 +- build.xml | 2 - 5 files changed, 422 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/31ce1778/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-asjs/blob/31ce1778/NOTICE ---------------------------------------------------------------------- diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..540ab0a --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +Apache Flex 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-asjs/blob/31ce1778/READme ---------------------------------------------------------------------- diff --git a/READme b/READme index 7c2986c..94db036 100644 --- a/READme +++ b/READme @@ -1,11 +1,215 @@ -FlexJS is a prototype of a new Flex framework that can be cross-compiled and produce an HTML/JS/CSS application that runs in any browser without Flash. +Apache FlexJS +============= -We have prototypes of a List, Button, Label, DropDownList, CheckBox, RadioButton, TextArea, and TextInput We have a prototype of a HTTPService and a LazyCollection - The best way to get started is to follow the instructions from https://cwiki.apache.org/confluence/display/FLEX/Using+FlexJS+with+Adobe+Flash+Builder. When you have completed the setup also complete the steps on that wiki page under "Creating a FlexJS Application". It is currently easier to modify the existing application example than to create a new application from scratch. Building and Running/Debugging As you edit the code, the regular Flex compiler is compiling and reporting errors, but it only knows how to build Flex SWFs so the output SWF probably won't run. So, before you debug, select the main MXML file in Package Explorer, choose from the Run menu the new External Tool: "FlexJS (Debug Build)". This will run the Falcon compiler with the right options to generate a SWF in the bin-debug folder that overwrites the one that is there. Then you should be able to set breakpoints and debug. Once you have your app working as a SWF, try the FalconJX External Tool. It will o utput a debug version to bin/js-debug and a minified version to bin/js-release. Run the index.html in any browser. Some browsers may require that you deploy to a server otherwise the network calls won't work. I'm sure there will be lots of issues, but feel free to comment or contribute. Remember, this is in its infancy so it will likely fall down easily and poop unexpectedly. + Apache FlexJS is a next-generation Flex SDK that has the goal of allowing + applications developed in MXML and ActionScript to not only run in the + Flash/AIR runtimes, but also to run natively in the browser without Flash, + on mobile devices as a PhoneGap/Cordova application, and in embedded JS + environments such as Chromium Embedded Framework. FlexJS has the potential + to allow your MXML and ActionScript code to run in even more places than + Flash currently does. -Using COMPC for Libraries + For detailed information about Apache Flex please visit + https://cwiki.apache.org/confluence/display/FLEX/FlexJS -As before, COMPC is used for building SWCs. If you don't have any MXML in your SWC, you can just use a regular Flex Library Project to create the SWC. If you have MXML in the SWC, then you will need to use a "FlexJS (COMPC)" external tool. Once you have a SWC, you can then try the "FlexJS (JS COMPC)" external tool to cross compile the SWC into a folder of JS files in folder called "js" in the project's folder. These JS files are not packaged into a SWC or ZIP. + For detailed information about Apache Flex please visit + http://flex.apache.org/ -Then, to build an application using a library, you would include the SWC in your library path, and for the "FlexJS (FalconX �)" configuration, you add the SWC in the library-path and then add a -sdk-js-lib option that points to the "js" folder in the SWC project. - \ No newline at end of file +Getting the latest sources via git +================================== + + Getting the source code is the recommended way to get Apache FlexJS. + 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-asjs.git asjs + cd asjs + 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 Apache FlexJS +====================== + + Apache FlexJS is a large project. It requires some build tools + which must be installed prior to building the SDK. + Some of these have different licenses. See the Software Dependencies section + for more information on the external software dependencies. + + 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 Apache FlexJS 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)) + + Google Closure Library (*3) GOOG_HOME + + Google Closure Linter (*4) see note + + Adobe Flash Player playerglobal swcs (*5) PLAYERGLOBAL_HOME + + JSHint (*6) see note + + Adobe Flex 'Falcon' Compiler (*7) FALCON_HOME + + Adobe Flex 'FalconJX' Compiler (*8) FALCONJX_HOME + + 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 Google Closure Library can be downloaded from: + https://closure-library.googlecode.com/files/closure-library-20130212-95c19e7f0f5f.zip + + Download the Google Closure Library and unzip it. Set GOOG_HOME to the + absolute path of the folder that contains the third_party and closure + sub-folders. + + *4) The Google Closure Linter can be found here: + http://code.google.com/p/closure-linter/downloads/list + + Follow the instructions here to install it. It should automatically + make the linter available. No need to change paths or environment + variables. + + *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 JSHint utility installed by following the instructions here: + http://www.jshint.com/install/ + + JSHint will also be automatically available. No need to change paths or + environment variables. + + *7) Set FALCON_HOME to the root of its SDK. When using the flex-falcon + repository, set + FALCON_HOME=<repo-path>/compiler/generated/dist/sdk + + *8) Set FALCONJX_HOME to the root of its SDK. When using the flex-falcon + repository, set + FALCONJX_HOME=<repo-path>/compiler.jx + +Software Dependencies +--------------------- + + The Apache FlexJS framework does not have direct dependencies on third-party + software. Applications built with Apache FlexJS need the Google Closure Library. + +Using the Binary Distribution +----------------------------- + + The binary distribution requires the download and installation of the third-party + dependencies before it can be used. + + 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 + + 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 <flex-asjs.dir> + ant main (or just ant since the default target is main) + + To clean the build, of everything other than the downloaded third-party + dependencies use + + ant 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 + + +Thanks for using Apache FlexJS. Enjoy! + + The Apache Flex Project + <http://flex.apache.org> http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/31ce1778/RELEASE_NOTES ---------------------------------------------------------------------- diff --git a/RELEASE_NOTES b/RELEASE_NOTES index 3e36608..a104c56 100644 --- a/RELEASE_NOTES +++ b/RELEASE_NOTES @@ -10,7 +10,9 @@ _____________ Adobe Flash Builder Integration -Flash Builder will not generate a correct MXML when using an Apache FlexJS SDK. +Flash Builder will not generate correct MXML when generating a new Flex Project +that uses an Apache FlexJS SDK. It is recommended that you copy an the MXML +for the main application from one of the FlexJS example applications. Please report new issues to our bugbase at: http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/31ce1778/build.xml ---------------------------------------------------------------------- diff --git a/build.xml b/build.xml index 597e111..3ea5630 100644 --- a/build.xml +++ b/build.xml @@ -502,8 +502,6 @@ <include name="installer.properties/**"/> <include name="READme"/> <include name="RELEASE_NOTES"/> - </fileset> - <fileset dir="${FLEX_SDK_HOME}"> <include name="LICENSE"/> <include name="NOTICE"/> </fileset>
