royale-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From erikdebr...@apache.org
Subject [royale-asjs] branch packaging updated: Pre-final version, committing to check on GitHub
Date Fri, 29 Sep 2017 11:48:03 GMT
This is an automated email from the ASF dual-hosted git repository.

erikdebruin pushed a commit to branch packaging
in repository https://gitbox.apache.org/repos/asf/royale-asjs.git


The following commit(s) were added to refs/heads/packaging by this push:
     new 3a1d3ab  Pre-final version, committing to check on GitHub
3a1d3ab is described below

commit 3a1d3ab9c0016d88a7c09368db82dc9b7510d308
Author: Erik de Bruin <erik@ixsoftware.nl>
AuthorDate: Fri Sep 29 13:47:52 2017 +0200

    Pre-final version, committing to check on GitHub
    
    Signed-off-by: Erik de Bruin <erik@ixsoftware.nl>
---
 README.md | 161 +++++++++++++++++++++++---------------------------------------
 1 file changed, 59 insertions(+), 102 deletions(-)

diff --git a/README.md b/README.md
index 345be0a..49ccb4f 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ You may also use a precompiled binary convenience package to develop FlexJS
appl
 
 Before building 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. The set of prerequisites is different depending on whether you want to compile your
projects to SWF or not.
 
-### Java
+#### Java
 
 FlexJS requires Java SDK 1.6 or greater to be installed on your computer. For more information
on installing the Java SDK, see:
 
@@ -36,11 +36,11 @@ FlexJS requires Java SDK 1.6 or greater to be installed on your computer.
For mo
 
 - **Environment variable**
 
-  Set the JAVA_HOME environment variable to the Java SDK installation path.
+  Set the **JAVA_HOME** environment variable to the Java SDK installation path.
 
 - **PATH**
 
-  Add the bin directory of JAVA_HOME to the PATH.
+  Add the bin directory of **JAVA_HOME** to the PATH.
 
   On Windows, set PATH to
   ```batch
@@ -52,19 +52,21 @@ FlexJS requires Java SDK 1.6 or greater to be installed on your computer.
For mo
   export PATH="$PATH:$JAVA_HOME/bin"
   ```
 
-### Ant
+#### Ant
 
-FlexJS requires Ant 1.7.1 or greater to be installed on your computer. For more information
on installing Ant, see:
+FlexJS requires Ant 1.7.1 or greater to be installed on your computer. 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.
+
+For more information on installing Ant, see:
 
 <http://ant.apache.org/>
 
 - **Environment variable**
 
-  Set the ANT_HOME environment variable to the Ant installation path.
+  Set the **ANT_HOME** environment variable to the Ant installation path.
 
 - **PATH**
 
-  Add the bin directory of ANT_HOME to the PATH.
+  Add the bin directory of **ANT_HOME** to the PATH.
 
   On Windows, set PATH to
   ```batch
@@ -76,150 +78,105 @@ FlexJS requires Ant 1.7.1 or greater to be installed on your computer.
For more
   export PATH="$PATH:$ANT_HOME/bin"
   ```
 
+#### playerglobal.swc
 
+The Adobe Flash Player playerglobal.swc for 11.1 can be downloaded from:
 
+<http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc>
 
+First, create the following directory structure:
 
+*[root directory]/player/11.1/*
 
+Next, rename the downloaded SWC to '*playerglobal.swc*' and place it in the above directory.
 
+- **Environment variable**
 
+  Set **PLAYERGLOBAL_HOME** environment variable to the absolute path of the player directory,
not including the version subdirectory (i.e. '*[root directory]/player*').
 
-============================================================================
-SOFTWARE                                    ENVIRONMENT VARIABLE    REQUIRED
-============================================================================
-
-Java SDK 1.6 or greater (*1)                JAVA_HOME               Yes
-    (for Java 1.7 see note at (*2))
-
-Ant 1.7.1 or greater (*1)                   ANT_HOME                Yes
-    (for Java 1.7 see note at (*2))
-
-Adobe Flash Player playerglobal swcs (*3)   PLAYERGLOBAL_HOME       Yes
-
-Adobe Flash Player Content Debugger (*5)    FLASHPLAYER_DEBUGGER    Yes
-
-Adobe AIR Integration Kit (*4)              AIR_HOME                SWF
-
-============================================================================
-
-1. The bin directories for ANT_HOME and JAVA_HOME should be added to your PATH.
-
-   On Windows, set PATH to
-
-   ```batch
-   PATH=%PATH%;%ANT_HOME%\bin;%JAVA_HOME%\bin
-   ```
-
-   On the Mac (bash), set PATH to
-
-   ```bash
-   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 Flash Player playerglobal.swc for 11.1 can be downloaded from:
-
-   <http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc>
-
-   Use the URL above to download playerglobal11_1.swc. Create a directory, create a folder
path in that directory for 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://<i></i>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>).
These can be used with Apache FlexJS, but not all versions have been fully tested.
 
-   Other more recent versions of Adobe Flash Player playerglobal.swc can be downloaded from:
 
-   http://<i></i>download.macromedia.com/get/flashplayer/updaters/[version.major]/playerglobal[version.major]_[version.minor].swc
+#### Flash Player Content Debugger
 
-   (e.g. <http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc>)
+The Adobe Flash Player content debugger can be found here:
 
-   These can be used with Apache FlexJS but not all have not been fully tested.
+<http://www.adobe.com/support/flashplayer/downloads.html>
 
-   Copy the target playerglobal.swc to the directory:
+This version of Apache FlexJS 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 16.0 on Windows and
Mac. It has been compiled, but not fully tested, with other Adobe Flash Player versions. It
has not been fully tested on Linux.
 
-   frameworks/libs/player/[version.major].[version.minor]/playerglobal.swc
+- **Environment variable**
 
-4. The Adobe AIR integration kit for Windows can be downloaded from:
+  On Windows, set **FLASHPLAYER_DEBUGGER** to the absolute path including the filename of
the FlashPlayerDebugger.exe. Note the filename of flash player debugger may be different,
e.g. 'C:\MyPath\FlashPlayerDebugger.exe'.
 
-   <http://airdownload.adobe.com/air/win/download/16.0/AdobeAIRSDK.zip>
+  On the Mac, set **FLASHPLAYER_DEBUGGER** to the absolute path of 'Flash Player.app/Contents/MacOS/Flash
Player Debugger'
 
-   The Adobe AIR integration kit for Mac can be downloaded from:
+  On Linux, set **FLASHPLAYER_DEBUGGER** to the absolute path of 'flashplayerdebugger'.
 
-   <http://airdownload.adobe.com/air/mac/download/16.0/AdobeAIRSDK.tbz2>
+#### Adobe AIR Integration Kit
 
-   The Adobe AIR integration kit for Linux can be downloaded from:
+This version of Apache FlexJS was certified for use with Adobe AIR 16 and is compatible with
version 3.1 and up. The Adobe AIR integration kit can be downloaded from:
 
-   <http://airdownload.adobe.com/air/lin/download/2.6/AdobeAIRSDK.tbz2>
+Windows: <http://airdownload.adobe.com/air/win/download/16.0/AdobeAIRSDK.zip>
 
-   Download the AIR SDK for your platform and unzip it. Set AIR_HOME to the absolute path
of the AIR SDK directory.
+Mac: <http://airdownload.adobe.com/air/mac/download/16.0/AdobeAIRSDK.tbz2>
 
-   This version of Apache FlexJS was certified for use with Adobe AIR 16 and is compatible
with version 3.1 and up.
+Linux: <http://airdownload.adobe.com/air/lin/download/2.6/AdobeAIRSDK.tbz2>
 
-5. The Adobe Flash Player content debuggers can be found here:
+After you download the AIR SDK, unzip it and place it in a directory of your choice.
 
-   <http://www.adobe.com/support/flashplayer/downloads.html>
+- **Environment variable**
 
-   This version of Apache FlexJS 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 16.0 on Windows and
Mac. It has been compiled, but not fully tested, with other Adobe Flash Player versions. It
has not been fully tested on Linux.
+  Set **AIR_HOME** to the absolute path of the AIR SDK directory.
 
-   On Windows, set FLASHPLAYER_DEBUGGER to the absolute path including the filename of the
FlashPlayerDebugger.exe. Note the filename of flash player debugger may be different, e.g.
C:\MyPath\FlashPlayerDebugger.exe.
+## Building the source
 
-   On the Mac, set FLASHPLAYER_DEBUGGER to the absolute path of 'Flash Player Debugger.app/Contents/MacOS/Flash
Player Debugger'
+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 dependencies below.
 
-   On Linux, set FLASHPLAYER_DEBUGGER to the absolute path of flashplayerdebugger.
+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.
 
-FlexJS requires code from several other Apache Royale git repositories. To get the latest
sources via git, first follow the instructions in ‘Prerequisites’, then from the royale-asjs
directory, run:
+FlexJS requires code from several other Apache Royale git repositories. To get these sources,
run:
 
 ```bash
+cd <royale-asjs.dir>
 ant all
 ```
 
 This will clone all of the upstream repositories, checkout the develop branches then run
the builds in those repositories in the correct order.
 
-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.
+Some more helpful commands:
 
-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.
+- To rebuild, run:
 
-## 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
-
-```bash
-cd <royale-asjs.dir>
-ant all (to clone upstream repos, build them and then Royale)
-```
-
-On subsequent builds, you can just run
-
-```bash
-ant main (or just ant since the default target is main)
-```
+  ```bash
+  ant
+  ```
 
-To clean the build, of everything other than the downloaded third-party dependencies use
+- To clean the build, of everything other than the downloaded third-party dependencies, run:
 
-```bash
-ant clean
-```
+  ```bash
+  ant clean
+  ```
 
-To generate a source distribution package and a binary distribution package use
+- To generate a source distribution package and a binary distribution package, run:
 
-```bash
-ant -Dbuild.number=<YYYYMMDD> -Dbuild.noprompt= release
-```
+  ```bash
+  ant -Dbuild.number=<YYYYMMDD> -Dbuild.noprompt= release
+  ```
 
-The packages can be found in the "out" subdirectory.
+  The packages can be found in the "out" subdirectory.
 
-To get a brief listing of all the targets type
+- To get a brief listing of all the targets, run:
 
-```bash
-ant -projecthelp
-```
+  ```bash
+  ant -projecthelp
+  ```
 
 ## Using the Binary Distribution
 
 If you are not interested in SWF output, the binary distribution can just be unzipped into
a folder.
 
-If you want SWF output, use NPM. Type:
+If you want SWF output, use NPM. Run:
 
 ```bash
 sudo npm install flexjs -g
@@ -227,6 +184,6 @@ sudo npm install flexjs -g
 
 # Software Dependencies
 
-The FlexJS framework depends on the Google Closure Library.
+FlexJS depends on the Google Closure Library.
 
 # Thanks for using [Apache Royale](http://royale.apache.org). Enjoy!

-- 
To stop receiving notification emails like this one, please contact
['"commits@royale.apache.org" <commits@royale.apache.org>'].

Mime
View raw message