You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by er...@apache.org on 2017/09/29 12:03:10 UTC
[royale-asjs] branch packaging updated: Some finishing touches
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 bad9a0f Some finishing touches
bad9a0f is described below
commit bad9a0fdeee8c58a0b31a5faca3953f6d3161dcb
Author: Erik de Bruin <er...@ixsoftware.nl>
AuthorDate: Fri Sep 29 14:03:00 2017 +0200
Some finishing touches
Signed-off-by: Erik de Bruin <er...@ixsoftware.nl>
---
README.md | 44 +++++++++++++++++++++++---------------------
1 file changed, 23 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index 49ccb4f..24564a9 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,18 @@
-# Apache Royale
+# Apache Royale™
-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 [...]
+The Apache Royale project is working on a next-generation Flex SDK: 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 FlexJS, please visit:
+For detailed information about FlexJS, visit:
<https://cwiki.apache.org/confluence/display/FLEX/FlexJS>
-For detailed information about Apache Royale, please visit:
+For more information about Apache Royale, visit:
<http://royale.apache.org>
# Getting FlexJS
-Getting the source code from GitHub is the recommended way to get FlexJS. You can checkout the source via git using the following commands:
+Getting the source code from GitHub is the recommended way to get FlexJS. You can check out the source via git using the following commands:
```bash
git clone https://github.com/apache/royale-asjs.git royale-asjs
@@ -26,9 +26,9 @@ You may also use a precompiled binary convenience package to develop FlexJS appl
## Prerequisites
-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.
+Before building FlexJS you must install the following software and set the corresponding environment variables using absolute file paths (relative 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:
@@ -52,9 +52,11 @@ 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. 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.
+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 you will get compile errors.
For more information on installing Ant, see:
@@ -78,9 +80,9 @@ For more information on installing Ant, see:
export PATH="$PATH:$ANT_HOME/bin"
```
-#### playerglobal.swc
+### playerglobal.swc
-The Adobe Flash Player playerglobal.swc for 11.1 can be downloaded from:
+The Adobe Flash Player *playerglobal.swc* (version 11.1) can be downloaded from:
<http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc>
@@ -94,26 +96,26 @@ Next, rename the downloaded SWC to '*playerglobal.swc*' and place it in the abov
Set **PLAYERGLOBAL_HOME** environment variable to the absolute path of the player directory, not including the version subdirectory (i.e. '*[root directory]/player*').
-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 (e.g. <http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc>). These versions can be used with FlexJS, but not all have been fully tested.
-#### Flash Player Content Debugger
+### Flash Player Content Debugger
-The Adobe Flash Player content debugger can be found here:
+The Flash Player Content Debugger can be found here:
<http://www.adobe.com/support/flashplayer/downloads.html>
-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.
+This version of FlexJS was certified for use with Flash Player 11.1, and is compatible with version 10.2 and up. It has been tested with version 16.0 on Windows and Mac. It has been compiled, but not fully tested, with other Flash Player versions. It has not been fully tested on Linux.
- **Environment variable**
- 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 Windows, set **FLASHPLAYER_DEBUGGER** to the absolute path including the filename of the Flash Player Content Debugger executable (e.g. 'FlashPlayerDebugger.exe'). Note: the filename of Flash Player Content Debugger can differ slightly between versions. Adjust your path accordingly.
On the Mac, set **FLASHPLAYER_DEBUGGER** to the absolute path of 'Flash Player.app/Contents/MacOS/Flash Player Debugger'
On Linux, set **FLASHPLAYER_DEBUGGER** to the absolute path of 'flashplayerdebugger'.
-#### Adobe AIR Integration Kit
+### Adobe AIR Integration Kit (optional, for SWF output only)
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:
@@ -133,16 +135,16 @@ After you download the AIR SDK, unzip it and place it in a directory of your cho
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.
-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.
+Linux support is currently experimental and while it is possible to compile the SDK it has not been fully tested.
-FlexJS requires code from several other Apache Royale git repositories. To get these sources, run:
+FlexJS requires code from several other Apache Royale git repositories. To get these repositories, 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.
+This will clone the repositories, checkout the develop branches then build those repositories in the correct order.
Some more helpful commands:
@@ -186,4 +188,4 @@ sudo npm install flexjs -g
FlexJS depends on the Google Closure Library.
-# Thanks for using [Apache Royale](http://royale.apache.org). Enjoy!
+### Thanks for using [Apache Royale](http://royale.apache.org). Enjoy!
--
To stop receiving notification emails like this one, please contact
['"commits@royale.apache.org" <co...@royale.apache.org>'].