You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by cf...@apache.org on 2012/09/07 20:59:14 UTC
svn commit: r1382126 - in /incubator/flex/utilities/trunk/installer: README
READme build.xml
Author: cframpton
Date: Fri Sep 7 18:59:13 2012
New Revision: 1382126
URL: http://svn.apache.org/viewvc?rev=1382126&view=rev
Log:
Edit README. Rename READme to README which is the Apache name. On the distro site README isn't visible so name it READme just for the distro site. Bump the Apache reqiured files like NOTICE, RELEASE_NOTES, DISCLAIMER, etc up to the top-level directory in the source package so they are visible when you unzip the source.
Added:
incubator/flex/utilities/trunk/installer/README
- copied, changed from r1382114, incubator/flex/utilities/trunk/installer/READme
Removed:
incubator/flex/utilities/trunk/installer/READme
Modified:
incubator/flex/utilities/trunk/installer/build.xml
Copied: incubator/flex/utilities/trunk/installer/README (from r1382114, incubator/flex/utilities/trunk/installer/READme)
URL: http://svn.apache.org/viewvc/incubator/flex/utilities/trunk/installer/README?p2=incubator/flex/utilities/trunk/installer/README&p1=incubator/flex/utilities/trunk/installer/READme&r1=1382114&r2=1382126&rev=1382126&view=diff
==============================================================================
--- incubator/flex/utilities/trunk/installer/READme (original)
+++ incubator/flex/utilities/trunk/installer/README Fri Sep 7 18:59:13 2012
@@ -17,57 +17,85 @@ limitations under the License.
-->
-==========================================================================================================================================================
+==========================================================================================
Overview:
=========
-- The InstallApacheFlex AIR application is intended to provide an easy, single-click installation of the Apache Flex SDK and all its dependencies.
-- This will make it suitable for working with IDEs such as Flash Builder, FDT, IntelliJ, FlashDevelop, etc.
- The downloaded dependencies include:
+- The InstallApacheFlex AIR application provides an easy, single-click installation of the
+ Apache Flex SDK and all its dependencies. This will make it suitable for working with
+ IDEs such as Adobe Flash Builder, FDT, IntelliJ IDEA, FlashDevelop, etc.
+ The application downloads the following dependencies:
- The AIR sdk (Windows vs. Mac) based on the current platform
- FlashPlayerGlobal.swc
- SwfObject
- - OSMF
- - TLF
+ - Open Source Media Framework (OSMF)
+ - Adobe Text Layout Format (TLF)
- Optionally, the application would download these files if the user explicitly agrees:
- - BlazeDS
- - FontSWF utility
+ Optionally, the application will download these files if the user explicitly agrees to
+ the licensing terms:
+ - Adobe BlazeDS
+ - Adobe embedded font support
- All the file names and urls of the downloaded files are available in installer/src/sdk-installer-config.xml.
- When the dependencies file names or urls change in future, update the sdk-installer-config.xml to ensure that the application works correctly.
-
-- The application uses http://incubator.apache.org/flex/single-mirror-url.cgi to determine the preferred mirror url to download Apache Flex SDK binary from.
-- Once the Apache Flex SDK binary file is downloaded, a MD5 has is generated from it. This hash is compared with the hash from the Apache Flex SDK release site.
- If they match, we verify that the downloaded binary file is a valid Apache release and proceed to unzip the file.
-- The AIR SDK will downloaded and the relevant files are copied to the required locations
-- The Flash player global swc files and the config files are placed in the required locations
-- Then the rest of the external dependencies and the optional files (if selected by user) are downloaded and copied into the appropriate locations.
-
-==========================================================================================================================================================
-Prerequisites and dependencies:
-===============================
-
-1. This project also needs the project 'common' that is in the source distribution. Make sure that the 'common' project lives in the same directory as the 'installer' project is.
-Just unzipping the source distribution would normally take care of this.
-
-2. Run: ant get-as3commons.swc
-This step downloads the required libraries and saves it in the libs directory
-
-3. In Flash Builder, add a linked resource called: APACHE_FLEX_UTILITIES_ROOT and point it to the directory path where the projects: 'installer' and 'common' are located.
+ All the file names and urls of the downloaded files are available in
+ installer/src/sdk-installer-config.xml.
+ When the dependencies file names or urls change in future, update the
+ sdk-installer-config.xml to ensure that the application works correctly.
+
+- The application uses http://incubator.apache.org/flex/single-mirror-url.cgi to determine
+ the preferred mirror url to download Apache Flex SDK binary from.
+
+- Once the Apache Flex SDK binary file is downloaded, a MD5 hash is generated for it.
+ This hash is compared with the hash from the Apache Flex SDK release site.
+ If they match, we verify that the downloaded binary file is a valid Apache release and
+ proceed to unzip the file.
+
+- The Adobe AIR SDK will be downloaded and the relevant files are copied to the required
+ locations.
+
+- The Adobe Flash Player global swc files and the config files are placed in the required
+ locations.
+
+- Then the rest of the external dependencies and the optional files (if selected by user)
+ are downloaded and copied into the appropriate locations.
-==========================================================================================================================================================
+==========================================================================================
How to build the installer using ANT (no Flash Builder or any other IDE required):
-===================================================================
+==========================================================================================
-1.a In the installer directory, run: ant build -DFLEX_HOME=/path/to/apache/flex/sdk -DAIR_HOME=/path/to/air/sdk
-or
-1.b Define these as environment variables: FLEX_HOME (path to Flex SDK) and AIR_HOME (path to AIR SDK)
- Then run "ant run" in the installer directory.
-or
-1.c Open the build.properties file and edit these variables to point them to the correct directory paths: FLEX_HOME and FLEX_HOME
- Then run "ant run" in the installer directory.
-
-2. The intaller executable file created in the installer/release directory. If you are on Windows, you will see an .exe file; if you are on Mac OS, you will see a .dmg file.
- A temporary digital signing certificate - temp.p12 will be created in the installer directory as well.
- The password for this file is available in the build.properties file (var: TEMP_PASS_CHANGE_THIS)
\ No newline at end of file
+1. Unzip the source distribution. You should see the 'installer' directory and the
+ 'common' directory in the root.
+
+2. In the installer directory, run:
+ ant build [-DFLEX_HOME=/path/to/apache/flex/sdk] [-DAIR_HOME=/path/to/air/sdk]
+
+ FLEX_HOME is the absolute path to the Apache Flex SDK
+ If you omit this argument, the FLEX_HOME_MAC or FLEX_HOME_WIN property in
+ installer/build.properties is used.
+
+ AIR_HOME is the absolute path to the Adobe AIR SDK
+ If you omit this argument, and the system environment variable, AIR_HOME, exists,
+ it is used. Otherwise, the AIR_HOME_MAC or AIR_HOME_WIN property in
+ installer/build.properties is used.
+
+2. The intaller executable file created in the installer/release directory. If you are
+ on Windows, you will see an .exe file; if you are on Mac OS, you will see a .dmg file.
+ A temporary digital signing certificate - temp.p12 will be created in the installer
+ directory as well. The password for this file is available in the build.properties
+ file (var: TEMP_PASS_CHANGE_THIS)
+
+==========================================================================================
+How to build the installer using Adobe Flash Builder (or any other IDE):
+==========================================================================================
+
+1. Unzip the source distribution. You should see the 'installer' directory and the
+ 'common' directory in the root.
+
+2. In the installer directory run:
+ ant get-as3commons.swc
+ This step downloads the required as3commons library and saves it in the libs
+ directory.
+
+3. If using Adobe Flash Builder, add a linked resource called:
+ APACHE_FLEX_UTILITIES_ROOT
+ and point it to the directory path where the 'installer' and 'common' directories are
+ located.
Modified: incubator/flex/utilities/trunk/installer/build.xml
URL: http://svn.apache.org/viewvc/incubator/flex/utilities/trunk/installer/build.xml?rev=1382126&r1=1382125&r2=1382126&view=diff
==============================================================================
--- incubator/flex/utilities/trunk/installer/build.xml (original)
+++ incubator/flex/utilities/trunk/installer/build.xml Fri Sep 7 18:59:13 2012
@@ -324,11 +324,29 @@
<exclude name="release/**"/>
<exclude name="rc/**"/>
<exclude name=".settings/**"/>
+ <!-- These are bumped up to the top-level release directory. -->
+ <exclude name="DISCLAIMER"/>
+ <exclude name="LICENSE"/>
+ <exclude name="NOTICE"/>
+ <exclude name="README"/>
+ <exclude name="RELEASE_GUIDE"/>
+ <exclude name="RELEASE_NOTES"/>
</fileset>
</copy>
-
- <copy file="${basedir}/READme" todir="${RELEASE_DIR}"/>
- <copy file="${basedir}/READme" todir="${BUILD_DIR}/temp"/>
+
+ <!-- Bump these up to the top-level release directory. -->
+ <copy todir="${BUILD_DIR}/temp" includeEmptyDirs="false">
+ <fileset dir="${basedir}">
+ <include name="DISCLAIMER"/>
+ <include name="LICENSE"/>
+ <include name="NOTICE"/>
+ <include name="README"/>
+ <include name="RELEASE_GUIDE"/>
+ <include name="RELEASE_NOTES"/>
+ </fileset>
+ </copy>
+
+ <copy file="${basedir}/README" tofile="${RELEASE_DIR}/READme"/>
<fixcrlf srcdir="${BUILD_DIR}/temp" eol="crlf" excludes="**/*.ttf,**/*.png"/>