This is an automated email from the ASF dual-hosted git repository.
andreww pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-asjs.wiki.git
The following commit(s) were added to refs/heads/master by this push:
new a825f3d minor text changes
a825f3d is described below
commit a825f3d663e0bd3d96b3f84f7826416f6940327e
Author: Andrew Wetmore <[email protected]>
AuthorDate: Mon Dec 9 17:59:53 2019 -0400
minor text changes
---
Build-Apache-Royale-with-Maven.md | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/Build-Apache-Royale-with-Maven.md
b/Build-Apache-Royale-with-Maven.md
index d705551..9209745 100644
--- a/Build-Apache-Royale-with-Maven.md
+++ b/Build-Apache-Royale-with-Maven.md
@@ -1,12 +1,12 @@
Apache Royale can be built with [Maven](https://maven.apache.org).
-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:
+Royale consists of three parts: The _compiler_, _typedefs_ and the
_framework(asjs)_. Each is hosted in a separate GIT repository and has to be
built and released separately. You build them in this order:
1. [Compiler](https://github.com/apache/royale-compiler)
2. [Typedefs](https://github.com/apache/royale-typedefs)
3. [Framework](https://github.com/apache/royale-asjs)
-In addition to building the framework libraries, the framework module also
assembles the binary distribution of the Royale SDK to use in your IDE of
choice.
+In addition to building the framework libraries, Maven also assembles the
binary distribution of the Royale SDK to use in your IDE of choice.
## Requirements
@@ -16,10 +16,10 @@ In addition to building the framework libraries, the
framework module also assem
2. Unpack the archive
3. Set your system PATH to the bin directory
-> if you don't have Maven installed, you can use **mvnw** (or [Maven
Wrapper](https://github.com/takari/maven-wrapper)) available in each root
repository folder, that allows you check if maven exists in your system and
install latest version if nothing is found.
+> if you don't have Maven installed, you can use **mvnw** (or [Maven
Wrapper](https://github.com/takari/maven-wrapper)) available in each root
repository folder, that allows you check if maven exists in your system and
install the latest version if nothing is found.
-3. Download the "Flash Player projector content debugger" for your system
from: https://www.adobe.com/support/flashplayer/debug_downloads.html (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.app/Contents/MacOS/Flash Player Debugger)
+3. Download the "Flash Player projector content debugger" for your system
from: https://www.adobe.com/support/flashplayer/debug_downloads.html (The
browser plugin or ActiveX component will not work).
+ 1. Create an environment variable called FLASHPLAYER_DEBUGGER and set it
to the path of the Flash Debug Player executable. On Windows and Linux machines
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.app/Contents/MacOS/Flash Player Debugger)
Example for Windows:
```sh
@@ -38,7 +38,7 @@ In addition to building the framework libraries, the
framework module also assem
## Build Steps
-1. First you need to build Compiler (royale-compiler)
+1. First build the Compiler (royale-compiler)
1. Clone:
```sh
@@ -56,9 +56,9 @@ In addition to building the framework libraries, the
framework module also assem
mvn clean install
```
- > This will execute all unit-tests and integration-tests. You can however
run the build without any tests adding `-DskipTests` or skip just the
integration-tests with `-DskipITs`
+ > This executes all unit and integration tests. You can run the build
without running any tests by adding `-DskipTests` or skip just the
integration-tests with `-DskipITs`.
-2. Next, build Typedefs (royale-typedefs)
+2. Next, build the Typedefs (royale-typedefs)
1. Clone:
```sh
@@ -94,21 +94,21 @@ In addition to building the framework libraries, the
framework module also assem
mvn clean install
```
-Now you have compiler, typedefs and framework ready. That's all :).
+Now you have the compiler, typedefs and framework ready. That's all :).
-> If you want to make some modification you can make the change and build only
the part that was modified and you'll be ready to use it in your own project.
To do so just go to the sub project folder and run `mvn clean install`.
+> If you want to make some modifications to your code you can make the changes
and then build only the part that was modified, and you'll be ready to use it
in your own project. To do so just go to the sub-project folder and run `mvn
clean install`.
### Optional Maven Profiles for Framework (royale-asjs)
-If you build without any profile, only framework is built, but no examples or
distribution. To build optional parts, the following profiles can be added to
the command line using `-P` maven option:
+If you build without any profile, the framework is built, but no examples or
distribution. To build the optional parts, add the following profiles to the
command line using the `-P` maven option:
-* **with-ui-testsuite**: It also builds the testsuite modules and runs the
integration-tests
+* **with-ui-testsuite**: It also builds the test suite modules and runs the
integration tests
> You can use [the latest
> geckodriver](https://github.com/mozilla/geckodriver/releases) to run the
> _Selenium UI tests in Firefox_ adding
> `-Dwebdriver.gecko.driver=/Users/christofer.dutz/Downloads/geckodriver`
-* **option-with-swf**: It also makes each module build the SWF version.
-* **with-examples**: It builds the all examples in `examples` folder too.
-* **with-distribution**: It lets the build also build the _distribution_ (the
Apache Royale SDK to use with an IDE). To build in the folder of your choice
use `-DdistributionTargetFolder={pathToDistributionDirectory}`.
+* **option-with-swf**: Makes each module build the SWF version.
+* **with-examples**: Builds the all examples in an `examples` folder.
+* **with-distribution**: Also builds the _distribution_ (the Apache Royale SDK
to use with an IDE). To build in the folder of your choice use
`-DdistributionTargetFolder={pathToDistributionDirectory}`.
-> Note: distribution is not completely working yet and needs to be fixed. In
the meanwhile you can use ANT to create a SDK from scratch from royale-asjs
root folder. Use `ant super-clean` to ensure the folder doesn't contain any
stale files that could make the process fail and the `ant all`.
+> Note: distribution is not completely working yet and needs to be fixed. In
the meanwhile you can use ANT to create a SDK from scratch from the royale-asjs
root folder. Use `ant super-clean` to ensure the folder doesn't contain any
stale files that could make the process fail, and then `ant all`.
Quick Summary of build steps using the convenient maven wrapper (mvnw) and all
available profiles:
