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 2014/11/17 20:33:26 UTC
[3/3] git commit: [flex-sdk] [refs/heads/develop] - FLEX-34636 and
then some ...
FLEX-34636 and then some ...
I've take a shot at rewriting the README to make it more readable, a bit more compact and accurate. Please review!
Signed-off-by: Erik de Bruin <er...@ixsoftware.nl>
Project: http://git-wip-us.apache.org/repos/asf/flex-sdk/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-sdk/commit/d72e2f20
Tree: http://git-wip-us.apache.org/repos/asf/flex-sdk/tree/d72e2f20
Diff: http://git-wip-us.apache.org/repos/asf/flex-sdk/diff/d72e2f20
Branch: refs/heads/develop
Commit: d72e2f20c1d2b4b4c30411b82a0724520973dc83
Parents: 1b2906e
Author: Erik de Bruin <er...@ixsoftware.nl>
Authored: Mon Nov 17 20:32:57 2014 +0100
Committer: Erik de Bruin <er...@ixsoftware.nl>
Committed: Mon Nov 17 20:32:57 2014 +0100
----------------------------------------------------------------------
README | 621 ++++++++++++++++++++++++------------------------------------
1 file changed, 246 insertions(+), 375 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flex-sdk/blob/d72e2f20/README
----------------------------------------------------------------------
diff --git a/README b/README
index 809d5a3..e640701 100644
--- a/README
+++ b/README
@@ -1,164 +1,119 @@
-Apache Flex (Flex)
-==================
+The Apache Flex SDK
+===================
-Apache Flex SDK is an application development framework for easily building
-Flash-based applications for mobile devices, web browsers, and desktops.
-
-Apache Flex 4.14.0 is a follow up release to Apache Flex 4.13.0. This version
-adds new features and implements bug fixes that were unavailable in previous
-versions. It is compatible with most code written to target Adobe Flex 4.6.
-
-For detailed information about Apache Flex please visit:
-
- http://flex.apache.org/
-
-Apache Flex is a large project with many pieces. The framework is implemented
-in ActionScript and the compiler is implemented in Java.
-
-Currently supported platforms include:
+The Apache Flex SDK is the evolution of the popular Adobe Flex SDK. The Apache
+Flex SDK is an application development framework for easily building Flash
+based applications for mobile devices, web browsers, and desktops. Currently
+supported platforms include:
Microsoft Windows
Mac OS X
Apple iOS
Google Android
RIM BlackBerry
- Linux
-
-Apache Flex is the software evolution of the popular Adobe Flex SDK project.
-
-The community surrounding Flex is vast, diverse, distributed globally, and with
-all levels of proficiency in software development.
-
-There has been more that 30,000 installs of Apache Flex. The Apache Flex web
-site gets 3 quarters of a million page views a year and more than 250,000
-unique visitors a year.
-
-
-
-Getting the convenience packages for Apache Flex
-================================================
+ (Linux)
-The Apache Flex SDK Installer is an application that simplifies the download
-and installation of the Apache Flex SDK and its (required) components. It is
-aimed at anyone who wants to use the latest release of the Apache Flex SDK, but
-who might not necessarily be familiar with the tools and procedures required to
-compile the Apache Flex SDK from source code. The application will grab the
-binary distribution of the SDK from apache.org or one of its mirrors, install
-it onto your computer and prepare it for use with your favorite IDE such as
-Adobe Flash Builder or JetBrains IntelliJ IDEA.
-
-You can get the SDK Installer from the Apache Flex website at
-
- http://flex.apache.org/installer.html
-
-The SDK installer requires the Adobe AIR runtime to be installed.
-
-Starting with Apache Flex 4.12 the binary distribution can be installed using
-only ANT in addition to the AIR installer mentioned above. This is the
-recommended method for Linux users. More information about installing the
-binary package with ANT can be found on our wiki at:
-
- https://cwiki.apache.org/confluence/display/FLEX/Installation+help#Installationhelp-Antinstaller
-
-
-
-Getting the latest sources via git
-==================================
+Linux support is currently experimental and you may run into issues. The Apache
+Flex project would like to see a fully supported Linux release, but we need
+help from the community in order to do that. Please help out if you can.
-Getting the source code is the recommended way to get Apache Flex. We also
-offer an automated installer along with binary distributions on our website at
+For more information about the Apache Flex project, please visit:
http://flex.apache.org/
-You can always checkout the latest source via git using the following command:
+The Apache Flex SDK 4.14.0 is a follow up release to version 4.13.0. It is
+compatible with most code written for the original Adobe Flex 4.6 SDK.
- git clone https://git-wip-us.apache.org/repos/asf/flex-sdk.git sdk
- cd sdk
- git checkout develop
-An Apache Flex SDK also requires source code from other Apache Flex git
-repositories. To get the latest source via git for the Text Layout Framework
-use the following command:
- git clone https://git-wip-us.apache.org/repos/asf/flex-tlf.git tlf
- cd tlf
- git checkout develop
+Installing the Apache Flex SDK
+==============================
-In an Apache Flex source code package hosted on the distribution server or one
-of its mirrors, the Text Layout Framework code is already included in the
-package. This is also true for the convenience package.
+The Apache Flex SDK Installer is an AIR application that simplifies the
+download and installation of the Apache Flex SDK and its (required) components.
+It is aimed at anyone who wants to use the latest release of the Apache Flex
+SDK, but who might not necessarily be familiar with the tools and procedures
+required to compile the Apache Flex SDK from source code. The application will
+grab the binary distribution of the SDK from apache.org or one of its mirrors,
+install it onto your computer and prepare it for use with your favourite IDE
+such as Adobe Flash Builder or JetBrains IntelliJ IDEA.
-Linux support is currently experimental and you may run into issues. Apache
-Flex would like to see a fully supported Linux release, but we need support
-from the community in order to do that. Please help out if you can.
+You can get the Apache Flex SDK Installer from the Apache Flex website at:
-For further information visit
+ http://flex.apache.org/installer.html
- http://flex.apache.org/download-source.html
+Starting with the Apache Flex SDK 4.12, Linux users can install the binary
+distribution using ANT. More information about installing the binary package
+with ANT can be found on our wiki at:
+ https://cwiki.apache.org/confluence/display/FLEX/Installation+help#Installationhelp-Antinstaller
-Building Apache Flex 4.14.0
-===========================
-Apache Flex is a large project. It requires some build tools which must be
-installed prior to building Flex 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.
+Building the Apache Flex SDK from source
+========================================
-From Apache's perspective, the Adobe Flash Player and Adobe AIR have excluded
-licenses so they can not be bundled with the Apache Flex binaries. They must be
-installed prior to building Apache Flex.
+The Apache Flex SDK is a large project. It requires build tools which must be
+installed on your system and it depends on some external software. The external
+software is downloaded as part of the build process.
-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.
+The following steps are all you need for a fully functional SDK:
+- Prepare your system
+ - install external software
+ - set environment variables
+- Get the source code
+ - flex-sdk
+ - flex-tlf
+- Build the SDK
+- Prepare the SDK for use with an IDE
+- Optional steps:
+ - Flash Player configuration
+ - Other locale support
-Install Prerequisites
----------------------
+Prepare your system
+-------------------
-Before building Flex you must install the following software and set the
-corresponding environment variables using absolute file paths. Relative file
-paths will result in build errors.
+Before building the Apache Flex SDK you must install the following software and
+set the corresponding environment variables. Make sure to use absolute paths,
+relative paths will result in build errors.
The environment variables PLAYERGLOBAL_HOME, AIR_HOME, FLASHPLAYER_DEBUGGER,
-TLF_HOME, and ADOBE_EXTENSION_MANAGER can also be set in the property file
+TLF_HOME, and ADOBE_EXTENSION_MANAGER can also be set in a property file
called env.properties. See the env-template.properties file for instructions.
-The Adobe Flash Player playerglobal.swc is needed to compile all the components
-with the exception of the airframework and airspark components which require
-airglobal.swc from the AIR Integration Kit. The AIR Integration kit is also
-needed to build and debug mobile applications. The Adobe Flash Player content
-debugger is used by checkintests and other pieces of the test subsystem to run
-compiled applications.
+The Adobe Flash Player and Adobe AIR have excluded licenses so they can not be
+bundled with the Apache Flex SDK, i.e. they need to be installed separately.
-The build scripts assume that the source code folder containing the Text Layout
-Framework (tlf) folder is at the same level as the sdk folder or located inside
-the frameworks/projects folder. If this is not true, then you must set the
-TLF_HOME environment variable to point to the tlf folder.
+The Adobe Flash Player ‘playerglobal.swc’ is needed to compile all the
+components with the exception of the ‘airframework’ and ‘airspark’
+components which require ‘airglobal.swc’ from the AIR Integration Kit. The
+AIR Integration kit is also needed to build and debug mobile applications. The
+Adobe Flash Player content debugger is used by the ant ‘checkintests’
+target and other pieces of the test subsystem to run compiled applications.
---------------------------------------------------------------------
-SOFTWARE ENVIRONMENT VARIABLE
---------------------------------------------------------------------
-Java SDK 1.6 or greater (* 1) JAVA_HOME
+---------------------------------------------------------------------
+SOFTWARE ENVIRONMENT VARIABLE
+---------------------------------------------------------------------
+
+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
+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 AIR Integration Kit (* 3) AIR_HOME
-Adobe Flash Player Content Debugger (* 4) FLASHPLAYER_DEBUGGER
+Adobe Flash Player Content Debugger (* 4) FLASHPLAYER_DEBUGGER
-Adobe Flash Player playerglobal swcs (* 5) PLAYERGLOBAL_HOME
+Adobe Flash Player playerglobal swcs (* 5) PLAYERGLOBAL_HOME
-Adobe Extension Manager CS5 (* 6) ADOBE_EXTENSION_MANAGER
+Optional: Text Layout Framework (* 6) TLF_HOME
-Text Layout Framework TLF_HOME
+Optional: Adobe Extension Manager CS5 (* 7) ADOBE_EXTENSION_MANAGER
---------------------------------------------------------------------
+---------------------------------------------------------------------
* 1)
The bin directories for ANT_HOME and JAVA_HOME should be added to your PATH.
@@ -169,9 +124,9 @@ On Windows, set PATH to
On the Mac (bash), set PATH to
- export PATH="$PATH:$ANT_HOME/bin:$JAVA_HOME/bin"
+ export PATH='$PATH:$ANT_HOME/bin:$JAVA_HOME/bin'
-On Linux make sure you path include ANT_HOME and JAVA_HOME.
+On Linux make sure your path includes 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
@@ -192,74 +147,185 @@ 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 15.0, and should be
-compatible with versions of AIR newer than 3.1. It has been fully tested on AIR
-3.7, 4 and 15.
-
Download the AIR SDK for your platform and unzip it. Set AIR_HOME to the
absolute path of the AIR SDK directory.
+This version of the Apache Flex SDK was certified for use with Adobe AIR 3.7
+and is compatible with version 3.1 and up. It has been fully tested on AIR 3.7,
+4 and 15.
+
* 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 15.0. It has been tested with
-versions 11.1, 11.7, 11.8, 11.9, 12.0, 13.0, 14.0 and 15.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.
+This version of the Apache Flex SDK was certified for use with Adobe Flash
+Player 11.1, and is compatible with version 10.2 and up. It has been tested
+with versions 11.1, 11.7, 13.0 and 15.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"
+'Flash Player Debugger.app/Contents/MacOS/Flash Player Debugger'
-On Linux, set FLASHPLAYER_DEBUGGER to the absolute path of flashplayerdebugger
+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.
-Information about downloading, setting up and support of the Adobe Flash Player
-can be found in the section "Adobe Flash Player Version Support" below.
+Additional information about downloading and setting up this and/or other
+versions of the Adobe Flash Player can be found in the section
+'Adobe Flash Player Version Support' below.
* 6)
+The build scripts assume that the source code folder containing the Apache Flex
+Text Layout Framework root folder ('flex-tlf') is at the same level as the SDK
+root folder ('flex-sdk'). See 'Getting the source code', below. If this is not
+the case on your system, then you must set the TLF_HOME environment variable to
+point to your TLF root folder.
+
+* 7)
The Adobe Extension Manager is only required for those creating releases or
-testing changes to the flash-integration swc. Note that if you change APIs on
+testing changes to the flash-integration SWC. Note that if you change APIs on
classes that flash-integration depends on, you may need to update
flash-integration.
-The Adobe Extension Manager for Windows can be downloaded from:
+On Windows, download the Adobe Extension Manager from:
http://download.macromedia.com/pub/dw_exchange/extension_manager/win/AdobeExtensionManager5All.zip
-The Adobe Extension Manager for Mac can be downloaded from:
+and set ADOBE_EXTENSION_MANAGER to the absolute path of
+'Adobe Extension Manager CS5.exe'
+
+On Mac, download the Adobe Extension Manager from:
http://download.macromedia.com/pub/dw_exchange/extension_manager/mac/AdobeExtensionManager5All.dmg
-On Windows, set ADOBE_EXTENSION_MANAGER to the absolute path of
-"Adobe Extension Manager CS5.exe"
+and set ADOBE_EXTENSION_MANAGER to the absolute path of
+'Adobe Extension Manager CS5.app/Contents/MacOS/Adobe Extension Manager CS5'
+
+On Linux, no Adobe Extension Manager exists.
+
+
+Get the source code
+-------------------
+
+The Apache Flex SDK source code uses git for SCM.
+
+You can get the latest source ('develop' branch) using the following commands:
+
+ git clone https://git-wip-us.apache.org/repos/asf/flex-sdk.git flex-sdk
+ cd flex-sdk
+ git checkout develop
+
+The Apache Flex SDK requires source code from the Apache Flex Text Layout
+Framework (TLF). To get the latest source for TLF ('develop' branch), use the
+following commands:
+
+ git clone https://git-wip-us.apache.org/repos/asf/flex-tlf.git flex-tlf
+ cd flex-tlf
+ git checkout develop
+
+For further information visit:
-On Mac, set ADOBE_EXTENSION_MANAGER to the absolute path of
-"Adobe Extension Manager CS5.app"
+ http://flex.apache.org/download-source.html
+
+
+Build the SDK
+-------------
+
+When you have all the prerequisites in place and the environment variables set,
+use these commands:
+
+ cd <flex-sdk>
+ ant main
+
+to download the third party dependencies and build the source. You will be
+prompted to acknowledge and/or confirm some of the downloads. 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.
+
+If you would like to build the RSLs, use:
+
+ ant frameworks-rsls
+
+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 super-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 build the ASDoc package, use:
+
+ ant asdoc-package
+
+To get a brief listing of all the targets type, use:
+
+ ant -projecthelp
+
+
+Prepare the SDK for use with an IDE
+-----------------------------------
+
+If you want to use the SDK you built from source in Adobe Flash Builder, you
+need to run these commands and scripts:
+
+ cd <flex.dir>
+ ant frameworks-rsls
+ ./ide/constructFlexForIDE.[sh/bat]
+ (Mac only: ./ide/addAIRtoSDK.sh)
+
+This builds the RSLS for the SDK and copy some IDE related files from the Adobe
+Flex SDK 4.6. On a Mac you will need to run the 'addAIRtoSDK.sh' script to
+complete the installation.
+
+To create an SDK for another IDE, or if you want to use a different version of
+Adobe AIR (Adobe Flex 4.6 uses Adobe AIR 3.1), run:
+
+ /ide/flashbuilder/makeApacheFlexForIDE.bat (on Windows)
+ /ide/flashbuilder/makeApacheFlexForIDE.sh (on Mac and Linux)
+
+
+
+Using the Binary Distribution
+=============================
+
+In order to use the binary distribution of the SDK, you must first download the
+third-party dependencies. First, make sure your system is good to go: see
+'Prepare your system' above. Note: you cannot use the env.properties file to
+set the environment variables when you use the Binany Distribution. Now, use:
+
+ cd <flex-sdk>/frameworks
+ ant thirdparty-downloads
+
+To complete the setup of the SDK, follow the instructions in the
+'Prepare the SDK for use with an IDE' section above.
-On Linux, no Adobe Extension Manager exists and there's nothing that needs to
-be done here.
FlashPlayer Configuration
--------------------------
+=========================
For testing, the Adobe Flash Player's mm.cfg file must have the following
entries
@@ -274,8 +340,9 @@ More information about these settings can be found here:
http://help.adobe.com/en_US/ActionScript/3.0_ProgrammingAS3/WS5b3ccc516d4fbf351e63e3d118a9b90204-7c95.html
+
Other Locale Support
---------------------
+====================
The Apache Flex SDK defaults to using the en_US locale and SDK error messages
are by default displayed in American English.
@@ -283,9 +350,9 @@ are by default displayed in American English.
To compile the SDK for another locale either:
Change the locale in the build.properties file to have a value other than
-"en_US". For this new locale to take effect the SDK needs to be recompiled. For
+'en_US'. For this new locale to take effect the SDK needs to be recompiled. For
example, to use the Australian English locale change locale to have a value of
-"en_AU" like so:
+'en_AU' like so:
locale = en_AU
@@ -308,11 +375,10 @@ unlikely to be any issues with a SDK compiled for another locales.
Adobe Flash Player Version Support
-----------------------------------
+==================================
The Apache Flex SDK defaults to using the Adobe Flash Player 11.1. The SDK can
-be used with Flash Player versions 10.2, 10.3, 11.0, 11.1, 11.2, 11.3, 11.4,
-11.5, 11.6, 11.7, 11.8, 11.9, 12.0, 13.0, 14.0 and 15.0.
+be used with Flash Player versions 10.2 and up.
It is recommended that you update to the latest version of Adobe Flash Player.
Newer versions of the Adobe Flash player address security vulnerabilities, fix
@@ -326,9 +392,9 @@ Adobe Flash Player.
OR
Change the playerglobal.version in the build.properties file to have a value
-other than "11.1". For this change to take effect the SDK needs to be
+other than '11.1'. For this change to take effect the SDK needs to be
recompiled. For example to compile against the latest version of the Adobe
-Flash Player set the value of playerglobal.version to be "14.0" like so:
+Flash Player set the value of playerglobal.version to be '14.0' like so:
playerglobal.version = 14.0
@@ -342,22 +408,14 @@ playerglobal.swc.
These can be found at:
-http://download.macromedia.com/get/flashplayer/installers/archive/playerglobal/playerglobal10_2.swc
-http://download.macromedia.com/get/flashplayer/installers/archive/playerglobal/playerglobal10_3.swc
-http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_0.swc
-http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc
-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
-http://download.macromedia.com/get/flashplayer/updaters/13/playerglobal13_0.swc
-http://download.macromedia.com/get/flashplayer/updaters/14/playerglobal14_0.swc
-http://download.macromedia.com/get/flashplayer/updaters/15/playerglobal15_0.swc
+ http://download.macromedia.com/get/flashplayer/installers/archive/playerglobal/playerglobal10_2.swc
+ http://download.macromedia.com/get/flashplayer/installers/archive/playerglobal/playerglobal10_3.swc
+
+and
+
+ http://download.macromedia.com/get/flashplayer/updaters/<version.major>/playerglobal<version.major>_<version.minor>.swc
+
+(e.g. http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc)
Copy the target playerglobal.swc to the directory:
@@ -366,61 +424,12 @@ Copy the target playerglobal.swc to the directory:
Where <version> is the major and minor version numbers of the Adobe Flash
Player separated by a period or full stop.
-If all of the playerglobal swcs where installed the frameworks/libs/player
-directory structure would look like this.
-
- /frameworks
- /libs
- /player
- /10.2
- /playerglobal.swc
- /10.3
- /playerglobal.swc
- /11.0
- /playerglobal.swc
- /11.2
- /playerglobal.swc
- /11.2
- /playerglobal.swc
- /11.3
- /playerglobal.swc
- /11.4
- /playerglobal.swc
- /11.5
- /playerglobal.swc
- /11.6
- /playerglobal.swc
- /11.7
- /playerglobal.swc
- /11.8
- /playerglobal.swc
- /11.9
- /playerglobal.swc
- /12.0
- /playerglobal.swc
- /13.0
- /playerglobal.swc
- /14.0
- /playerglobal.swc
- /15.0
- /playerglobal.swc
-
-Apache Flex has been tested with Adobe Flash Player 11.1, 11.5, 11.7, 11.8,
-11.9, 12.0, 13.0, 14.0 and 15.0 on Windows and Mac.
-
-Apache Flex has not been tested on Linux so some issues may exist in this
-release.
-
-It compiles against other Adobe Flash Player versions and is expected to work
-but there may be some issues, particularly with the earlier 10.2 and 10.3
-versions of the Adobe Flash Player.
-
Software Dependencies
----------------------
+=====================
-Apache Flex uses third-party code that will be downloaded as part of the Apache
-Flex build. In addition, there is some optional third-party code that you can
+The Apache Flex SDK uses third-party code that will be downloaded as part of
+the build. In addition, there is some optional third-party code that you can
choose to download if you would like to take advantage of the features offered
and you agree to the license terms.
@@ -445,15 +454,15 @@ reciprocal licenses so you will be prompted to acknowledge the license before
the software is downloaded to your system. These files are installed in
frameworks/libs.
- osmf.swc
-
- Open Source Media Framework v1.0 used for video components
+ osmf.swc (Open Source Media Framework v1.0; used for video components)
This file is extracted from:
- http://sourceforge.net/projects/osmf.adobe/files/OSMF%201.0%20%28final%20source%2C%20ASDocs%2C%20PDF%20guides%2C%20and%20release%20notes%29/OSMF_1.0.zip/download
- This software is released under the Mozilla Public License Version 1.1:
- <http://www.mozilla.org/MPL/>
+ http://sourceforge.net/projects/osmf.adobe/files/OSMF%201.0%20%28final%20source%2C%20ASDocs%2C%20PDF%20guides%2C%20and%20release%20notes%29/OSMF_1.0.zip/download
+
+ and is released under the Mozilla Public License Version 1.1:
+
+ http://www.mozilla.org/MPL/
The following dependencies have licenses which Apache considers to be not
compatible with the Apache License Version 2.0. You will be prompted to read
@@ -461,167 +470,29 @@ and agree to the license terms of the dependency before the software can be
downloaded to your system. These are optional components which enable
additional features. They are installed in libs/external/optional.
- flex-messaging-common.jar
+ flex-messaging-common.jar (provides integration with Adobe BlazeDS)
- Provides integration with Adobe BlazeDS.
+ This file is extracted from:
- This files are extracted from:
- http://fpdownload.adobe.com/pub/flex/sdk/builds/flex4.6/flex_sdk_4.6.0.23201B.zip
+ http://fpdownload.adobe.com/pub/flex/sdk/builds/flex4.6/flex_sdk_4.6.0.23201B.zip
- This software is released under an Adobe license:
- <http://www.adobe.com/products/eulas/pdfs/adobe_flex_software_development_kit-combined-20110916_0930.pdf>
+ and is released under an Adobe license:
- adt.jar
- afe.jar
- aglj40.jar
- flex-fontkit.jar
- rideau.jar
+ http://www.adobe.com/products/eulas/pdfs/adobe_flex_software_development_kit-combined-20110916_0930.pdf
- Adobe proprietary software which provides embedded font support.
+ adt.jar, afe.jar, aglj40.jar, flex-fontkit.jar and rideau.jar (provides embedded font support)
These jars are extracted from:
- http://fpdownload.adobe.com/pub/flex/sdk/builds/flex4.6/flex_sdk_4.6.0.23201B.zip
-
- This software is released under an Adobe license:
- <http://www.adobe.com/products/eulas/pdfs/adobe_flex_software_development_kit-combined-20110916_0930.pdf>
-
-
-
-Using the Binary Distribution
-=============================
-
-You must download the third-party dependencies.
-
-When you have all the prerequisites in place and the environment variables set,
-(see Install Prerequisites above -- you cannot use the env.properties file to
-set the environment variables for these steps.), use
-
- cd <flex.dir>/frameworks
- ant thirdparty-downloads
-
-Additionally, you will need to build the RSLS for the SDK before you run the
-batch files.
-
- cd <flex.dir>
- ant frameworks-rsls
-
-To use this SDK in a IDE like Flash Builder 4.6 or 4.7 the SDK needs several
-other files to be packaged and integrated with the Apache Flex SDK.
-
-If you have an existing installation of Flash Builder run:
- /ide/constructFlexForIDE.sh (on Mac and Linux)
- /ide/constructFlexForIDE.bat (on Windows)
+ http://fpdownload.adobe.com/pub/flex/sdk/builds/flex4.6/flex_sdk_4.6.0.23201B.zip
-This will create an Apache Flex 4.14.0 SDK that can be used with Flash Builder
-by copying the required files from the Adobe Flex 4.6 SDK.
-
-To create an SDK for other IDE or if you want to use Adobe AIR 14.0
- (rather than AIR 3.1 contained in Adobe Flex 4.6) run:
-
- /ide/flashbuilder/makeApacheFlexForIDE.sh (on Mac and Linux)
- /ide/flashbuilder/makeApacheFlexForIDE.bat (on Windows)
-
-This will create an Apache Flex 4.14.0 SDK that can be used by an IDE by
-downloading Adobe Flex 4.6 SDK and Adobe AIR 14.0.
-
-
-Building the Framework in a Binary Distribution
------------------------------------------------
-
-The source for most of the framework is included in the binary distribution. It
-can be useful if you wish to debug and/or extend components.
-
-When you have all the prerequisites in place and the environment variables set,
-(see Install Prerequisites above), use
-
- cd <flex.dir>/frameworks
- ant main (or just ant since the default target is main)
-
-to download the third-party dependencies and build the Flex framework. You may
-be prompted to acknowledge some of the downloads. 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
+ and are released under an Adobe license:
- ant clean
-
-To clean the build, of everything, including the downloaded third-party
-dependencies use
-
- ant super-clean (which is just thirdparty-clean followed by clean)
-
-
-Building the Source in the Source Distribution
-----------------------------------------------
-
-The source for both the Flex compiler and the Flex framework is included in the
-source distribution. The compiler is in the modules directory and the framework
-is in the frameworks directory.
-
-Because the sdk uses the Text Layout Framework, you will have to clone it too
-and link it to the textLayout project of the sdk:
-
- cd <flex.dir>/..
- git clone https://git-wip-us.apache.org/repos/asf/flex-tlf.git tlf
-
-When you have all the prerequisites in place and the environment variables set
-(see Install Prerequisites above), use
-
- cd <flex.dir>
- ant main (or just ant since the default target is main)
-
-to download the thirdparty dependencies and build the source. You may be
-prompted to acknowledge and/or confirm some of the downloads. 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.
-
-If you would like to build the RSLs, use
-
- ant frameworks-rsls
-
-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 super-clean (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 build the ASDoc package
-
- ant asdoc-package
-
-To get a brief listing of all the targets type
-
- ant -projecthelp
-
-
-
-Using the SDK in Flash Builder
-==============================
-
-If you want to use the SDK you build from source in Flash Builder, you need to
-run these commands/scripts:
-
- cd <flex.dir>
- ant frameworks-rsls
- ./ide/constructFlexForIDE.[sh/bat]
- [if you're on a Mac, also run: ./ide/addAIRtoSDK.sh]
+ http://www.adobe.com/products/eulas/pdfs/adobe_flex_software_development_kit-combined-20110916_0930.pdf
-Thanks for using Apache Flex. Enjoy!
+Thanks for using the Apache Flex SDK. Enjoy!
The Apache Flex Project
<http://flex.apache.org>