royale-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From erikdebr...@apache.org
Subject [royale-asjs] 01/02: A bit of a rewrite
Date Fri, 29 Sep 2017 11:03:21 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

commit 58130518af4c7f138dfad7a91a74c05f3c5d4cc2
Author: Erik de Bruin <erik@ixsoftware.nl>
AuthorDate: Fri Sep 29 13:02:22 2017 +0200

    A bit of a rewrite
    
    Signed-off-by: Erik de Bruin <erik@ixsoftware.nl>
---
 READme | 295 +++++++++++++++++++++++++++++++++++------------------------------
 1 file changed, 159 insertions(+), 136 deletions(-)

diff --git a/READme b/READme
index 237bc26..345be0a 100644
--- a/READme
+++ b/READme
@@ -1,209 +1,232 @@
-Apache Royale
-=============
+# Apache Royale
 
-    Apache Royale 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. 
+The Apache Royale project is working on a next-generation Flex SDK, called FlexJS. FlexJS
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 curre [...]
 
-    For detailed information about Apache Flex please visit
-    https://cwiki.apache.org/confluence/display/FLEX/FlexJS
+For detailed information about FlexJS, please visit:
 
-    For detailed information about Apache Flex please visit
-    http://flex.apache.org/
+<https://cwiki.apache.org/confluence/display/FLEX/FlexJS>
 
-Getting the latest sources via git
-==================================
+For detailed information about Apache Royale, please visit:
 
-    Getting the source code is the recommended way to get Apache FlexJS.  
-    You may also use a precompiled binary convenience package to develop
-    FlexJS applications using your favorite IDE.  FlexJS is also
-    available as Maven artifacts and via Node Package Manager (NPM).
+<http://royale.apache.org>
 
-    You can always checkout the latest source via git using the following
-    command:
+# Getting FlexJS
 
-	 git clone https://github.com/apache/royale-asjs.git royale-asjs
-	 cd royale-asjs
-	 git checkout develop
+Getting the source code from GitHub is the recommended way to get FlexJS. You can checkout
the source via git using the following commands:
 
-Building Apache FlexJS via Ant
-==============================
+```bash
+git clone https://github.com/apache/royale-asjs.git royale-asjs
+cd royale-asjs
+git checkout develop
+```
 
-    Apache Royale also requires code from several other Apache Royale git
-    repositories.  To get the latest sources via git, first follow the
-    instructions in ‘Install Prerequisites’, then from the royale-asjs
-    directory, run:
-    
-         ant all
+You may also use a precompiled binary convenience package to develop FlexJS applications
using your favorite IDE. In addition to that, FlexJS is available as Maven artifacts and through
Node Package Manager (NPM).
 
-    This will clone all of the upstream repositories, checkout the develop branches
-    then run the builds in those repositories in the correct order.
+# Building FlexJS
 
+## Prerequisites
 
-    Apache Royale 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.
+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.
 
-    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.
+### Java
 
-Install Prerequisites
----------------------
+FlexJS requires Java SDK 1.6 or greater to be installed on your computer. For more information
on installing the Java SDK, see:
 
-    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.  The set of prerequisites
-    is different depending on whether you want to compile to SWF or not.
+<http://www.oracle.com/technetwork/java/javase/downloads/index.html>
 
-    ==================================================================================
-    SOFTWARE                                    ENVIRONMENT VARIABLE       REQUIRED
-    ==================================================================================
+- **Environment variable**
 
-    Java SDK 1.6 or greater (*1)                JAVA_HOME                    Yes
-        (for Java 1.7 see note at (*2))
+  Set the JAVA_HOME environment variable to the Java SDK installation path.
 
-    Ant 1.7.1 or greater (*1)                   ANT_HOME                     Yes
-        (for Java 1.7 see note at (*2))
+- **PATH**
 
-    Adobe Flash Player playerglobal swcs (*3)   PLAYERGLOBAL_HOME            SWF
+  Add the bin directory of JAVA_HOME to the PATH.
 
-    Adobe AIR Integration Kit (*4)              AIR_HOME                     SWF
+  On Windows, set PATH to
+  ```batch
+  PATH=%PATH%;%JAVA_HOME%\bin
+  ```
 
-    Adobe Flash Player Content Debugger (*5)    FLASHPLAYER_DEBUGGER         SWF
+  On a Mac, set PATH to
+  ```bash
+  export PATH="$PATH:$JAVA_HOME/bin"
+  ```
 
-    ==================================================================================
+### Ant
 
-    *1) The bin directories for ANT_HOME and JAVA_HOME should be added to your
-        PATH.
+FlexJS requires Ant 1.7.1 or greater to be installed on your computer. For more information
on installing Ant, see:
 
-        On Windows, set PATH to
+<http://ant.apache.org/>
 
-            PATH=%PATH%;%ANT_HOME%\bin;%JAVA_HOME%\bin
+- **Environment variable**
 
-        On the Mac (bash), set PATH to
+  Set the ANT_HOME environment variable to the Ant installation path.
 
-            export PATH="$PATH:$ANT_HOME/bin:$JAVA_HOME/bin"
+- **PATH**
 
-        On Linux make sure you path include ANT_HOME and JAVA_HOME.
+  Add the bin directory of ANT_HOME to the PATH.
 
-    *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.
+  On Windows, set PATH to
+  ```batch
+  PATH=%PATH%;%ANT_HOME%\bin
+  ```
 
-    *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
+  On a Mac, set PATH to
+  ```bash
+  export PATH="$PATH:$ANT_HOME/bin"
+  ```
 
-        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://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 have not been fully
-        tested.
 
 
-        Copy the target playerglobal.swc to the directory:
 
-            frameworks/libs/player/<version.major>.<version.minor>/playerglobal.swc
 
-    *4) The Adobe AIR integration kit for Windows can be downloaded from:
+============================================================================
+SOFTWARE                                    ENVIRONMENT VARIABLE    REQUIRED
+============================================================================
 
-           http://airdownload.adobe.com/air/win/download/16.0/AdobeAIRSDK.zip
+Java SDK 1.6 or greater (*1)                JAVA_HOME               Yes
+    (for Java 1.7 see note at (*2))
 
-        The Adobe AIR integration kit for Mac can be downloaded from:
+Ant 1.7.1 or greater (*1)                   ANT_HOME                Yes
+    (for Java 1.7 see note at (*2))
 
-           http://airdownload.adobe.com/air/mac/download/16.0/AdobeAIRSDK.tbz2
+Adobe Flash Player playerglobal swcs (*3)   PLAYERGLOBAL_HOME       Yes
 
-        The Adobe AIR integration kit for Linux can be downloaded from:
+Adobe Flash Player Content Debugger (*5)    FLASHPLAYER_DEBUGGER    Yes
 
-           http://airdownload.adobe.com/air/lin/download/2.6/AdobeAIRSDK.tbz2
+Adobe AIR Integration Kit (*4)              AIR_HOME                SWF
 
-        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 Apache FlexJS was certified for use with Adobe AIR 16
-        and is compatible with version 3.1 and up.
+1. The bin directories for ANT_HOME and JAVA_HOME should be added to your PATH.
 
-    *5) The Adobe Flash Player content debuggers can be found here:
+   On Windows, set PATH to
 
-           http://www.adobe.com/support/flashplayer/downloads.html
+   ```batch
+   PATH=%PATH%;%ANT_HOME%\bin;%JAVA_HOME%\bin
+   ```
 
-        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.
+   On the Mac (bash), set PATH to
 
-        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.
+   ```bash
+   export PATH="$PATH:$ANT_HOME/bin:$JAVA_HOME/bin"
+   ```
 
-        On the Mac, set FLASHPLAYER_DEBUGGER to the absolute path of
-        'Flash Player Debugger.app/Contents/MacOS/Flash Player Debugger'
+   On Linux make sure you path include ANT_HOME and JAVA_HOME.
 
-        On Linux, set FLASHPLAYER_DEBUGGER to the absolute path of flashplayerdebugger.
+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:
 
-Software Dependencies
----------------------
+   <http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc>
 
-    The Apache FlexJS framework depends on the Google Closure Library.
+   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.
 
-Building the Source in the Source Distribution
-----------------------------------------------
+   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.
 
-    When you have all the prerequisites in place and the environment variables
-    set (see Install Prerequisites above), use
+   Other more recent versions of Adobe Flash Player playerglobal.swc can be downloaded from:
 
-        cd <royale-asjs.dir>
-        ant all         (to clone upstream repos, build them and then Royale)
+   http://<i></i>download.macromedia.com/get/flashplayer/updaters/[version.major]/playerglobal[version.major]_[version.minor].swc
 
-    On subsequent builds, you can just run
-        ant main        (or just ant since the default target is main)
+   (e.g. <http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc>)
 
-    To clean the build, of everything other than the downloaded third-party
-    dependencies use
+   These can be used with Apache FlexJS but not all have not been fully tested.
 
-        ant clean
+   Copy the target playerglobal.swc to the directory:
 
-    To generate a source distribution package and a binary distribution package
-    use
+   frameworks/libs/player/[version.major].[version.minor]/playerglobal.swc
 
-        ant -Dbuild.number=<YYYYMMDD> -Dbuild.noprompt= release
+4. The Adobe AIR integration kit for Windows can be downloaded from:
 
-    The packages can be found in the "out" subdirectory.
+   <http://airdownload.adobe.com/air/win/download/16.0/AdobeAIRSDK.zip>
 
-    To get a brief listing of all the targets type
+   The Adobe AIR integration kit for Mac can be downloaded from:
 
-        ant -projecthelp
+   <http://airdownload.adobe.com/air/mac/download/16.0/AdobeAIRSDK.tbz2>
 
-Using the Binary Distribution
------------------------------
+   The Adobe AIR integration kit for Linux can be downloaded from:
 
-    If you are not interested in SWF output, the binary distribution can just 
-    be unzipped into a folder.
+   <http://airdownload.adobe.com/air/lin/download/2.6/AdobeAIRSDK.tbz2>
 
-    If you want SWF output, use NPM.  Type:
+   Download the AIR SDK for your platform and unzip it. Set AIR_HOME to the absolute path
of the AIR SDK directory.
 
-        sudo npm install flexjs -g
+   This version of Apache FlexJS was certified for use with Adobe AIR 16 and is compatible
with version 3.1 and up.
 
+5. The Adobe Flash Player content debuggers can be found here:
 
-Thanks for using Apache FlexJS.  Enjoy!
+   <http://www.adobe.com/support/flashplayer/downloads.html>
 
-                                          The Apache Flex Project
-                                          <http://flex.apache.org>
+   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.
+
+   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.
+
+   On the Mac, set FLASHPLAYER_DEBUGGER to the absolute path of 'Flash Player Debugger.app/Contents/MacOS/Flash
Player Debugger'
+
+   On Linux, set FLASHPLAYER_DEBUGGER to the absolute path of flashplayerdebugger.
+
+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:
+
+```bash
+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.
+
+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.
+
+## 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)
+```
+
+To clean the build, of everything other than the downloaded third-party dependencies use
+
+```bash
+ant clean
+```
+
+To generate a source distribution package and a binary distribution package use
+
+```bash
+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
+
+```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:
+
+```bash
+sudo npm install flexjs -g
+```
+
+# Software Dependencies
+
+The FlexJS framework 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