royale-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [] branch master updated: first draft of
Date Fri, 17 Nov 2017 19:07:45 GMT
This is an automated email from the ASF dual-hosted git repository.

carlosrovira pushed a commit to branch master
in repository

The following commit(s) were added to refs/heads/master by this push:
     new e762108  first draft of
e762108 is described below

commit e762108221bdfa23bd1a3290501d7e4de1f7bbb1
Author: Carlos Rovira <>
AuthorDate: Fri Nov 17 20:07:44 2017 +0100

    first draft of
--- | 74 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)

diff --git a/ b/
new file mode 100644
index 0000000..12536f7
--- /dev/null
+++ b/
@@ -0,0 +1,74 @@
+Apache Royale can be built with maven. Royale consists of three parts: The _compiler_, _typedefs_
and the _framework(asjs)_, each is hosted in a separate GIT repository and have to be built
and released separately. The order hereby is:
+1. Compiler
+2. Typedefs
+3. Framework
+In addition to building the framework libraries, the framework module also assembles the
binary distribution of the Royale SDK.
+It also has a feature of **assembling a fully functional FlexJS distribution** in a directory
of choice, by setting an additional environment variable: _distributionTargetFolder_. If you
set this to the path of a directory, the build will create a distribution there. This can
then be used directly in your IDE of choice.
+## Steps
+1. Install Java from:
+2. Install Maven 3.3.1 or greater from: (I used 3.3.9)
+    1. Download the archive
+    2. Unpack the archive
+    3. Set your systems PATH to the bin directory (I usually define a MAVEN_HOME to the unpacked
directory and then add $MAVEN_HOME/bin to the PATH)
+3. Download the "Flash Player projector content debugger" for your system from:
(The Browser plugin or ActiveX component will not work)
+    1. Set an environment variable called FLASHPLAYER_DEBUGGER and set it to the path of
the Flash Debug Player executable (On windows and Linux machined this is trivial as you simply
provide the full path (including the executable name), on Mac's this will look something like
this: {Place the Player is installed to}/Flash Player Debugger)
+     Example for Windows: 
+`FLASHPLAYER_DEBUGGER=C:\Program Files\Adobe\Flash\flashplayer_22_sa_debug.exe`
+     Example for Linux:
+     Example for Mac:
Player Debugger`
+4. Build Compiler (flex-falcon)
+    1. Clone:
+`git clone royale-compiler`
+    2. Go into the new directory:
+`cd royale-compiler
+git checkout develop'
+Build the compiler:
+`mvn -s settings-template.xml clean install`
+This will execute all unit-tests and integration-tests. You can however run the build without
any tests:
+`mvn -s settings-template.xml -DskipTests clean install`
+And if you just want to run the unit-tests and skip the integration-tests:
+`mvn -s settings-template.xml -DskipITs clean install`
+Note: we are fixing the text due to the migration, so you need to add -DskipTests to the
line above to get a successful build. We'll remove this line when we fix all the test.
+Build Typedefs (flex-typedefs)
+git clone royale-typedefs
+Go into the new directory:
+cd royale-typedefs
+git checkout develop
+Build the typedefs:
+mvn -s settings-template.xml clean install
+Build the Framework (royale-asjs)
+git clone royale-asjs
+Go into the new directory:
+cd royale-asjs
+git checkout develop
+Build the framework libs:
+mvn -s settings-template.xml clean install
+optionally you can also build the distribution binaries:
+mvn -s settings-template.xml -P build-distribution clean install
+optionally you can also build the distribution binaries and a local distribution (including
dependencies for Flash, AIR) in a local directory:
+mvn -s settings-template.xml -DdistributionTargetFolder={pathToDistributionDirectory} -P
build-distribution clean install
\ No newline at end of file

To stop receiving notification emails like this one, please contact
['"" <>'].

View raw message