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 ffda9a7 Updated Eclipse Setup (markdown)
ffda9a7 is described below
commit ffda9a7253b96d4c217c7739bf7b48d2f4d1f3c3
Author: aharui <aha...@apache.org>
AuthorDate: Sun Jun 3 08:03:36 2018 -0700
Updated Eclipse Setup (markdown)
---
Eclipse-Setup.md | 82 +++++++++++++++++++++++++++++++-------------------------
1 file changed, 45 insertions(+), 37 deletions(-)
diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md
index 5962581..9135ab1 100644
--- a/Eclipse-Setup.md
+++ b/Eclipse-Setup.md
@@ -1,25 +1,28 @@
## Eclipse Setup
-Setup of the royale-compiler project in Eclipse should be pretty
straight-forward. There are 7 Eclipse projects which have dependencies on each
other and they should all be imported into Eclipse:
-1. `compiler`
-2. `compiler-common`
-3. `compiler-externc`
-4. `compiler-jx`
-5. `compiler-test-utils`
-6. `compiler-build-tools`
-7. `compiler-jburg-types`
+Eclipse is used by many of the compiler developers, although it is possible to
make changes with text editors and Apache Ant or Apache Maven.
-Aditonally, there is a classpath variable used in the `compiler` project which
references `ANT_JAR`. A class path variable named `ANT_JAR` should be created
in the Eclipse preferences which should reference the file named `ant.jar`
located in the ant distribution on your computer.
+This is the setup for developers working with the source code in Eclipse. If
you only want to build applications with the Royale Compiler, see the [Royale
User Guide](user-guide).
-All of these projects should be at the top-level of the royals-compiler repo.
There are other projects there as well and it should be ok to import all of
them.
+### Prerequisites
-### Setup Debug Configurations
+First you will need the following prerequisites:
-This is the setup for developers working with the source code. If you only
want to build applications with the Royale Compiler, see the [Royale User
Guide](user-guide).
+A. Git
+Git is a source code management application. Some computers come with Git
installed. To find out if you have Git installed run
+
+git --version
+
+Git should print out its version if it is already installed. If not, install
Git for your platform from here: http://git-scm.com/downloads. Many folks
prefer GUI versions of Git, which is fine as long as there is a command-line
version as well. Add Git to your PATH environment variable.
+Downloading and Building the Source
-First you will need the following prerequisites:
+Get the source code from Apache Git via
+
+git clone https://git-wip-us.apache.org/repos/asf/royale-compiler
royale-compiler
+cd royale-compiler
+git checkout develop
-A. Java SE JDK 1.7 or later
+B. Java SE JDK 1.7 or later
Some computers come with Java installed, but not only do you need a Java
runtime (JRE) you need a Java Development Kit (JDK). To find out if you have a
JDK installed run
`javac -version`
@@ -28,54 +31,59 @@ The Java Compiler (javac) should print out its version if
its already installed.
Add the "bin" folder from wherever you installed it to your environment's PATH
variable.
Create a new JAVA_HOME environment variable that points to the folder
containing unzipped files.
-B. Apache Ant
+C. Apache Ant
Get Apache Ant from https://ant.apache.org/bindownload.cgi. Unzip it
somewhere.
Add the "bin" folder from wherever you install it to your environment's PATH
variable.
Create a new ANT_HOME environment variable that points to the folder
containing the unzipped files.
-C. Adobe AIR SDK (Only required for SWF output)
+D. Adobe AIR SDK (Only required for SWF output)
Get a recent Adobe AIR SDK for Windows or Mac. Unzip it somewhere. Note that
there are two types of AIR SDKs for each platform and the default type does not
work well with Flex so use the links provided or make sure you select the
Flex-compatible versions on the Adobe site.
Create a new AIR_HOME environment variable that points to the folder
containing the unzipped files.
-D. Adobe Flash Player playerglobal.swc (Only required for SWF output)
+E. Adobe Flash Player playerglobal.swc (Only required for SWF output)
Get a recent playerglobal.swc file from the Adobe Flash Player Downloads page:
https://www.adobe.com/support/flashplayer/downloads.html. You will have to
scroll down a bit to find the link. Here, for example, is a link to the
playerglobal.swc for Adobe Flash Player 18.0. The filename will include the
version number (e.g. playerglobal18_0.swc). Rename the file to
playerglobal.swc and place it in a folder containing the version number (e.g.
18.0/playerglobal.swc on Mac and 18.0\playerg [...]
Create a PLAYERGLOBAL_HOME environment variable that points to the folder
containing the folder with the version number. In the example above, it would
be /Users/myusername/adobe/flashplayer on Mac and/or c:\adobe\flashplayer on
Windows.
-E. Adobe Flash Player Projector Content Debugger (Only required for SWF output)
+F. Adobe Flash Player Projector Content Debugger (Only required for SWF output)
Get a recent Projector Content Debugger (aka Standalone Debug Player) for your
platform from the Adobe Flash Player Downloads page:
https://www.adobe.com/support/flashplayer/downloads.html.
Create a FLASHPLAYER_DEBUGGER environment variable that points to the
Debugger. For example, on Mac, if you store the Debugger in
"/Users/myusername/adobe/flashplayer/18.0/Flash Player Debugger.app", you would
set the environment variable to:
"/Users/myusername/adobe/flashplayer/18.0/Flash Player
Debugger.app/Contents/MacOS/Flash Player Debugger" (without quotes) and on
Windows, if you store the Debugger in
c:\adobe\flashplayer\18.0\flashplayer_18_sa_debug.exe, you would set the
environment variable to c:\adobe\flashplayer\18.0\flashplayer_18_sa_debug.exe.
-F. Git
-Git is a source code management application. Some computers come with Git
installed. To find out if you have Git installed run
-
-git --version
-
-Git should print out its version if it is already installed. If not, install
Git for your platform from here: http://git-scm.com/downloads. Many folks
prefer GUI versions of Git, which is fine as long as there is a command-line
version as well. Add Git to your PATH environment variable.
-Downloading and Building the Source
+### Setting up Eclipse
-Get the source code from Apache Git via
-
-git clone https://git-wip-us.apache.org/repos/asf/royale-compiler
royale-compiler
-cd royale-compiler
-git checkout develop
+In the royale-compiler folder, run 'ant'. The Eclipse projects are not set up
to generate some of the helper classes in some of the project folders but is
looking for files generated by the Ant build.
+
+There are 7 Eclipse projects which have dependencies on each other and they
should all be imported into Eclipse:
+1. `compiler`
+2. `compiler-common`
+3. `compiler-externc`
+4. `compiler-jx`
+5. `compiler-test-utils`
+6. `compiler-build-tools`
+7. `compiler-jburg-types`
+
+Additonally, there is a classpath variable used in the `compiler` project
which references `ANT_JAR`. A classpath variable named `ANT_JAR` should be
created in the Eclipse preferences which should reference the file named
`ant.jar` located in the Apache Ant distribution on your computer. If you
don't have Apache Ant, you will need to install it.
+
+All of these projects should be at the top-level of the royale-compiler repo.
There are other projects there as well and it should be ok to import all of
them.
+
+## Using Eclipse
-In the royale-compiler folder, run 'ant'.
+We are using Eclipse Helios for Java 1.6 compatibility because at least one of
the jars (flex-oem-compiler) needs to be 1.6 compatible to work with Flash
Builder.
-Using Eclipse
+### Run/Debug Configurations
-We are using Eclipse Helios for Java 1.6 compatibility because at least one of
the jars (flex-oem-compiler) needs to be 1.6 compatible to work with Flash
Builder. There are eclipse project files in the royale-compiler repo. The
run/debug configuration for building a Royale SWF in Eclipse needs the
following settings (Assuming the path to the flex-asjs repo is
/Users/myusername/git/apache/flex/flex-asjs):
+The run/debug configuration for building a Royale SWF in Eclipse needs the
following settings (Assuming the path to the royale-asjs repo is
/Users/myusername/git/apache/royale/royale-asjs):
Program Arguments:
-+royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" -debug
/Users/myusername/git/apache/flex/flex-asjs/examples/flexjs/DataBindingExample/src/DataBindingExample.mxml
++royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" -debug
/Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/DataBindingExample.mxml
VM Arguments:
--Xmx384m -Dsun.io.useCanonCaches=false
-Dflexcompiler="/Users/myusername/git/apache/flex/flex-falcon/compiler"
-Dflexlib="/Users/myusername/git/apache/flex/flex-asjs/frameworks"
+-Xmx384m -Dsun.io.useCanonCaches=false
-Droyalecompiler="/Users/myusername/git/apache/royale/royale-compiler/compiler"
-Droyalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks"
And the environment variables:
PLAYERGLOBAL_HOME points to the folder containing versions of playerglobal.swc
as specified above. Thus, if you followed the instructions above on a Mac, you
would set the variable to: /Users/myusername/adobe/flashplayer
-For cross-compiling with FalconJX the Program Arguments are:
+For cross-compiling with Royale Compiler the Program Arguments are:
-+flexlib="/Users/myusername/git/apache/flex/flex-asjs/frameworks" -debug
/Users/myusername/git/apache/flex/flex-asjs/examples/flexjs/DataBindingExample/src/DataBindingExample.mxml
-js-output-type=FLEXJS
\ No newline at end of file
++royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" -debug
/Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/DataBindingExample.mxml
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
aha...@apache.org.
