You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ha...@apache.org on 2017/12/29 09:06:15 UTC

[royale-asjs.wiki] branch master updated: Added info on building from source

This is an automated email from the ASF dual-hosted git repository.

harbs 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 d6989c8  Added info on building from source
d6989c8 is described below

commit d6989c8b69a547a7debdecb2f6f51cc8587c10d2
Author: Harbs <ha...@in-tools.com>
AuthorDate: Fri Dec 29 11:06:09 2017 +0200

    Added info on building from source
---
 Building-From-Source.md | 23 +++++++++++++++++++++++
 _Sidebar.md             |  1 +
 2 files changed, 24 insertions(+)

diff --git a/Building-From-Source.md b/Building-From-Source.md
new file mode 100644
index 0000000..d41ea6a
--- /dev/null
+++ b/Building-From-Source.md
@@ -0,0 +1,23 @@
+## Building From Source
+The Royale SDK can be built using either `ant` or `maven`. Below are instructions for both.
+
+### Ant Build
+
+#### Prerequisites:
+1. Java 7 or later should be installed.
+2. Apache Ant should be installed.
+
+#### Steps to Build
+1. [Clone the Royale Framework repo.](https://github.com/apache/royale-asjs.git)
+2. Make sure you are using the `develop` branch.
+3. Open the folder of the cloned repo in a terminal.
+4. Run `ant all`.
+
+This will clone all the necessary repos and build them all in the correct order. It will also add the necessary files to use the royale-asjs folder as a working SDK. You should be able to point your IDE (i.e. VS Code, Moonshine, Flash Builder, etc.) to the royale-asjs folder and it should be recognized and "just work".
+
+#### Notes
+- If you are working on Framework features, once the original `ant all` is run, you should be able to build individual swcs by running ant on the specific project.
+- To make changes to the new js swcs available in active projects, you need to clean the project and remove the old .js files in the `bin/js-debug` folder. Those files are not overwritten by default.
+
+### Maven Build
+TODO need info from Maven folks.
\ No newline at end of file
diff --git a/_Sidebar.md b/_Sidebar.md
index fbf7a8d..cd464ab 100644
--- a/_Sidebar.md
+++ b/_Sidebar.md
@@ -10,6 +10,7 @@
 
 ## Setup & Migration
 - [Source Code Repositories](Apache-Royale-Source-Code-Repositories)
+- [Building From Source](Building-From-Source.md)
 - [Sample Build Scripts](build-scripts)
     - [Build Apache Royale with Maven](Build-Apache-Royale-with-Maven)
 - [Migrating From Flex](migrating-flex)

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