royale-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aha...@apache.org
Subject [royale-compiler.wiki] branch master updated: Created User Guide (markdown)
Date Wed, 30 May 2018 22:50:58 GMT
This is an automated email from the ASF dual-hosted git repository.

aharui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-compiler.wiki.git


The following commit(s) were added to refs/heads/master by this push:
     new 8cc9139  Created User Guide (markdown)
8cc9139 is described below

commit 8cc913988e44068b5b98e32c78c8ca4c9c9b1a95
Author: aharui <aharui@apache.org>
AuthorDate: Wed May 30 15:50:56 2018 -0700

    Created User Guide (markdown)
---
 User-Guide.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/User-Guide.md b/User-Guide.md
new file mode 100644
index 0000000..78c8aee
--- /dev/null
+++ b/User-Guide.md
@@ -0,0 +1,23 @@
+The Royale Compiler does many things besides compile MXML and ActionScript into JavaScript.
 But if that's all you want to do, you can use the compiler with Apache Maven, Apache Ant,
several IDEs, NPM and the command-line.  Below are some pointers to getting started.
+
+### Apache Maven
+
+There are some examples in the apache/royale-asjs repo in the examples folder.  The pom.xml
files should be useful as a starting point.  There are also Maven archetypes available in
Apache Royale releases.
+
+
+### Apache Ant
+
+In an Apache Royale distribution, there is a compiler-royaleTasks.jar in the js/lib folder
that contains Ant tasks for the Royale Compiler.  There is an mxmlc task for creating applications
and a compc task for creating libraries.
+
+### IDEs
+
+Consult your IDE documentation for how to launch the Royale Compiler.
+
+### NPM
+
+You should be able to run mxmlc or compc from the command-line after installing Royale via
NPM.  Use 'mxmlc --help' to see the latest list of options.
+
+### Command-line
+
+The js/bin folder should contain mxmlc and compc scripts that will launch the compiler. 
Use 'mxmlc --help' to see the latest list of options.
+

-- 
To stop receiving notification emails like this one, please contact
aharui@apache.org.

Mime
View raw message