incubator-flex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From erikdebr...@apache.org
Subject svn commit: r1407426 - in /incubator/flex/utilities/trunk/mavenizer: README.txt download-sources.txt
Date Fri, 09 Nov 2012 11:27:30 GMT
Author: erikdebruin
Date: Fri Nov  9 11:27:29 2012
New Revision: 1407426

URL: http://svn.apache.org/viewvc?rev=1407426&view=rev
Log:
Chris updated the README (FLEX-33246), which makes the 'download-sources.txt' obsolete.

Removed:
    incubator/flex/utilities/trunk/mavenizer/download-sources.txt
Modified:
    incubator/flex/utilities/trunk/mavenizer/README.txt

Modified: incubator/flex/utilities/trunk/mavenizer/README.txt
URL: http://svn.apache.org/viewvc/incubator/flex/utilities/trunk/mavenizer/README.txt?rev=1407426&r1=1407425&r2=1407426&view=diff
==============================================================================
--- incubator/flex/utilities/trunk/mavenizer/README.txt (original)
+++ incubator/flex/utilities/trunk/mavenizer/README.txt Fri Nov  9 11:27:29 2012
@@ -1,27 +1,115 @@
-1. Download all the SDKs (Flex & AIR).
-2. Extract all of them into one directory.
-3. Modify the "flex-sdk-description.xml" of the Flex SDK 2.0.1.180927 so the version is "2.0.1"
-4. Create a target directory where all the artifacts will be generated.
-5. Execute the tool:
-    java SDKGenerator "source-directory" "target-directory"
+/////////////////////////////////////////////////////////////////////////////////////////
+The Mavenizer tool is used to convert the Apache and Adobe Flex SDKs and Air SDKs into
+Maven artifacts. Automatically creating the Directories, pom-files, copying and moving 
+the resources to the correct destinations.
 
+These artifacts can be used in Maven builds using the Flexmojos plugin (Starting with
+version 6.x).
+/////////////////////////////////////////////////////////////////////////////////////////
+
+The generator automatically converts the desired FDKs into a mavenized form, all you 
+need, is to download and unzip the archives containing the sdks and execute the 
+generator passing in the source and target directory as parameter. 
+
+The Generator doesn't stupidly copy all java libraries to the destination, but checks
+if the given artifact has already been deployed to maven central or by deploying an
+other FDK previously. For this check you do need an internet connection to do the
+conversion, otherwise I think this will probably take forever.
+
+Internally it consists of 3 components: 
+- One for deploying the Flash artifacts
+- One for deploying the Air artifacts
+- One for deploying the Flex artifacts
+
+As the Adobe FDKs all contained the AIR SDK and the Flash runtime the FDK directories
+are processed by each of the FDK directories. When deploying the Flex SDK the references
+to the flash and air artifacts are done based upon the playerglobal.swc and 
+airglobal.swc. The Generator compares the checksum of the file contained in the FDK
+with that of already deployed artifacts (I think in one of the 3.x FDKs the 
+"AIR SDK Readme.txt" stated the version to be a different version than it actually was).
+
+The Flash version used isn't detected by looking at the playerglobal.swc but by having
+a look at the content of the file "flex-config.xml" in the directory 
+"{fdkroot}/frameworks". Unfortunately I couldn't find a similar reference to a desired
+AIR version in any of the config files.
+
+/////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////////////////////////////////////////////////
+								!!! WARNING !!!
+/////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////////////////////////////////////////////////
+I would suggest not to generate the artifacts into your local repo directly, but
+to generate it to an empty directory and then move it from there.
+/////////////////////////////////////////////////////////////////////////////////////////
+
+Here come the steps needed to build the Generator (Assuming you already have a working
+Maven installation)
+
+1. Checkout the code (The directory containing the pom.xml I will call {home} from now on)
+2. Go to the directory {home}
+3. Execute "mvn package"
+
+You should now have a jar file called flex-sdk-converter-1.0.jar in your {home}/target
+directory.
+
+Using the generator:
+
+1. Prepare the source directory:
+	a) Create a directory anywhere (I will call it {sdkhome} from now on).
+	b) Create a directory {sdkhome}/air (optionally if you want to deploy Air SDKs).
+		I) Copy the AIR SDK archives you downloaded into {sdkhome}/air 
+		II) Unpack the archives in that directory, so the path to the "AIR SDK Readme.txt"
+		    is as follows "{sdkhome}/air/AdobeAIRSDK-{Airversion}-{Airplatform}/AIR SDK Readme.txt"
+			(Actually the name of the "AdobeAIRSDK-*" directory doesn't matter, it's just important
+			for the sequence in which the artifacts are generated)
+	c) Create a directory {sdkhome}/flex (optionally if you want to deploy Flex SDKs).
+		I) Copy the Flex SDK archives you downloaded into {sdkhome}/flex
+		II) Unpack the archived in that directory, so the path to the "flex-sdk-description.xml"
+		    is as follows "{sdkhome}/flex/flex_sdk_{Flexversion}/flex-sdk-description.xml"
+			(Actually the name of the "flex_sdk_*" directory doesn't matter, it's just important
+			for the sequence in which the artifacts are generated)
+	d) Create a directory anywhere which will contain the output (I will call it {fdktarget}

+	   from now on)
+	e) Change to the directory {home}
+	f) Execute the following command: "java -cp target/flex-sdk-converter-1.0.jar SDKGenerator
"{sdkhome}" "{fdktarget}""
+	   (You should wrap the both directory names in double-quotes if they contain spaces)
+
+/////////////////////////////////////////////////////////////////////////////////////////
+Some notes to things I noticed in dealing with some of the SDKs
+/////////////////////////////////////////////////////////////////////////////////////////
+	   
 Flex SDK 2.0:
-- Version is strange "3.0 Moxie M2.180927". Has to be changed to 2.0.1.180927 in flex-sdk-description.xml
+- Version is strange "3.0 Moxie M2.180927". Has to be changed to 2.0.1.180927 in flex-sdk-description.xml

 
-Flex 3.0.0.477A:
-- Create text-file called "AIR SDK Readme.txt" in the Flex 3.0.0.477A SDK with following
content:
-Adobe AIR 1.?.? SDK
-
-Flex 3.0.1.1732A:
-- Create text-file called "AIR SDK Readme.txt" in the Flex 3.0.1.1732A SDK with following
content:
-Adobe AIR 1.?.? SDK
-
-Flex 3.2.0.3958A:
-- Create text-file called "AIR SDK Readme.txt" in the Flex 3.1.0.2710A SDK with following
content:
-Adobe AIR 1.?.? SDK
+With the first three Flex SDKs (3.0.0.477A, 3.0.1.1732A and 3.2.0.3958A) I did have some

+trouble finding out the AIR version as well as the binary artifacts. The sizes and 
+checksums of the airglobal.swc didnt match any of the official AIR artifacts and the adl

+command didn't output a version. Currently without tweaking these FDKs are generated 
+without working AIR support.
+If however you need one of these FDKs you can simply make the generator use the air 
+version you want, by copying the airglobal.swc of the version you want to use into the
+directory "{fdkroot}/frameworks/libs/air" assuming you have deployed any FDK or Air SDK 
+containing that version of airglobal, the generator will correctly add dependencies to
+that AIR version.
 
 Flex 4.8.0.1359417:
-- Needs "player" directory in "framework" in order to execute compc (Copy from Flex 4.6.0).
-- "osmf" and "textlayout" are not included in 4.8.0 so they need to be copied from 4.6.0
(Rember to also copy the RSLs)
-- Needs to detect the AIR version the FDK is compatable with, this is currently determined
by checking the version of
-    the airglobal.swc in the framework/libs/air/airglobal.swc. Simply copy this from the
4.6 FDK
+- Needs a "player" directory in "framework" in order to execute compc (Copy from Flex 4.6.0).
+- Needs all the dependencies in place "textlayout", "osmf" and the stuff that needs to
+  be copied into the "{fdkroot}/lib/external" and "{fdkroot}/lib/external/optional" 
+  directories. For more instructions on this, please read the README.txt in the root of
+  Your FDK.
+- Needs to detect the AIR version the FDK is compatible with, this is currently determined

+  by checking the version of the airglobal.swc in the framework/libs/air/airglobal.swc. 
+  Simply copy this from the 4.6 FDK
+
+/////////////////////////////////////////////////////////////////////////////////////////
+Some of the urls to access the binary distributions:  
+/////////////////////////////////////////////////////////////////////////////////////////
+  
+AIR SDKs (From Adobe):  
+http://helpx.adobe.com/air/kb/archived-air-sdk-version.html
+
+Flex SDKs (From Adobe):
+(Unfortunately the page seems messed-up, but you can get the URLs from there)
+http://sourceforge.net/adobe/flexsdk/wiki/downloads/
+



Mime
View raw message