[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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 72c34e2 Updated Eclipse Setup (markdown) 72c34e2 is described below commit 72c34e282c576ffd878f5112d56639e7a57c41c1 Author: aharui AuthorDate: Wed Dec 26 19:58:05 2018 -0800 Updated Eclipse Setup (markdown) --- Eclipse-Setup.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md index 2b430ab..6c0fd37 100644 --- a/Eclipse-Setup.md +++ b/Eclipse-Setup.md @@ -23,7 +23,7 @@ git clone https://git-wip-us.apache.org/repos/asf/royale-compiler royale-compile cd royale-compiler git checkout develop -**B. Java SE JDK 1.7 or later**\ +**B. Java SE JDK 1.8**\ 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` @@ -72,7 +72,7 @@ All of these projects should be at the top-level of the royale-compiler repo. T ## Using Eclipse -We are using Eclipse Helios for Java 1.6 compatibility because at least one of the jars (flex-compiler-oem) needs to be 1.6 compatible to work with Flash Builder. +We are using Eclipse 20181210 for Java 1.8 compatibility. In theory, any version of Eclipse that supports Java 1.8 should work. ### Run/Debug Configurations @@ -95,4 +95,4 @@ VM Arguments: `-Xmx384m -Dsun.io.useCanonCaches=false -Droyalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks"` And the environment variables (Only required for SWF Output): -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. +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. \ No newline at end of file
[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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-compiler.wiki.git The following commit(s) were added to refs/heads/master by this push: new acdac8e Updated Eclipse Setup (markdown) acdac8e is described below commit acdac8e3179e837854d3c4e54d80b532b05c9b90 Author: Harbs AuthorDate: Tue Aug 7 11:56:40 2018 +0300 Updated Eclipse Setup (markdown) --- Eclipse-Setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md index 652f6c8..2b430ab 100644 --- a/Eclipse-Setup.md +++ b/Eclipse-Setup.md @@ -88,7 +88,7 @@ Main Class: Program Arguments: -`+royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" +configname=royale -debug -closure-lib= /Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/DataBindingExample.mxml` +`+royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" +configname=royale -debug -closure-lib= /Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/main/royale/DataBindingExample.mxml` VM Arguments:
[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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 d951b40 Updated Eclipse Setup (markdown) d951b40 is described below commit d951b4013486c2764179f0b5cf21b043b59de8ef Author: aharui AuthorDate: Sun Jun 3 22:20:39 2018 -0700 Updated Eclipse Setup (markdown) --- Eclipse-Setup.md | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md index fe2245a..652f6c8 100644 --- a/Eclipse-Setup.md +++ b/Eclipse-Setup.md @@ -37,18 +37,18 @@ 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. -D. Google Closure Library +**D. Google Closure Library**\ The Google Closure Library is required to actually make production versions and run debug or production applications. You can check this file: https://github.com/apache/royale-asjs/blob/develop/frameworks/downloads.xml and search for "gcl-download" to see which version is currently being used. You can use the "subset-goog" Ant target in the above downloads.xml file to remove files that aren't being used and speed up compile time a bit. -E. Adobe AIR SDK (Only required for SWF output) +**E. 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 and Royale 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. -F. Adobe Flash Player playerglobal.swc (Only required for SWF output) +**F. 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. -G. Adobe Flash Player Projector Content Debugger (Only required for SWF output) +**G. 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. -- To stop receiving notification emails like this one, please contact aha...@apache.org.
[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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 4c5bbc6 Updated Eclipse Setup (markdown) 4c5bbc6 is described below commit 4c5bbc6f9c8b797f0c5071d3a9d06ac3fc67a4d9 Author: aharui AuthorDate: Sun Jun 3 22:19:21 2018 -0700 Updated Eclipse Setup (markdown) --- Eclipse-Setup.md | 14 -- 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md index 34d2c21..fe2245a 100644 --- a/Eclipse-Setup.md +++ b/Eclipse-Setup.md @@ -8,12 +8,13 @@ This is the setup for developers working with the source code in Eclipse. If you First you will need the following prerequisites: -A. Git +**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 Get the source code from Apache Git via @@ -22,7 +23,7 @@ git clone https://git-wip-us.apache.org/repos/asf/royale-compiler royale-compile cd royale-compiler git checkout develop -B. 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` @@ -31,12 +32,13 @@ 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. -C. 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. D. Google Closure Library +The Google Closure Library is required to actually make production versions and run debug or production applications. You can check this file: https://github.com/apache/royale-asjs/blob/develop/frameworks/downloads.xml and search for "gcl-download" to see which version is currently being used. You can use the "subset-goog" Ant target in the above downloads.xml file to remove files that aren't being used and speed up compile time a bit. E. 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 and Royale so use the links provided or make sure you select the Flex-compatible versions on the Adobe site. @@ -70,7 +72,7 @@ All of these projects should be at the top-level of the royale-compiler repo. T ## Using Eclipse -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. +We are using Eclipse Helios for Java 1.6 compatibility because at least one of the jars (flex-compiler-oem) needs to be 1.6 compatible to work with Flash Builder. ### Run/Debug Configurations @@ -86,11 +88,11 @@ Main Class: Program Arguments: -`+royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" +configname=royale -debug /Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/DataBindingExample.mxml` +`+royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" +configname=royale -debug -closure-lib= /Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/DataBindingExample.mxml` VM Arguments: `-Xmx384m -Dsun.io.useCanonCaches=false -Droyalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks"` And the environment variables (Only required for SWF Output): -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 +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. -- To stop receiving notification emails like this one, please contact aha...@apache.org.
[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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 57cad80 Updated Eclipse Setup (markdown) 57cad80 is described below commit 57cad8058fa73f7563031283705be432ffc254aa Author: aharui AuthorDate: Sun Jun 3 08:14:32 2018 -0700 Updated Eclipse Setup (markdown) --- Eclipse-Setup.md | 8 +--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md index d3f6169..34d2c21 100644 --- a/Eclipse-Setup.md +++ b/Eclipse-Setup.md @@ -36,15 +36,17 @@ 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. -D. Adobe AIR SDK (Only required for SWF output) +D. Google Closure Library + +E. 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 and Royale 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. -E. Adobe Flash Player playerglobal.swc (Only required for SWF output) +F. 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. -F. Adobe Flash Player Projector Content Debugger (Only required for SWF output) +G. 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. -- To stop receiving notification emails like this one, please contact aha...@apache.org.
[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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 f3ca83f Updated Eclipse Setup (markdown) f3ca83f is described below commit f3ca83f9791cbee7721e3159c99ec0f8a54dac06 Author: aharui AuthorDate: Sun Jun 3 08:12:28 2018 -0700 Updated Eclipse Setup (markdown) --- Eclipse-Setup.md | 21 + 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md index 9135ab1..d3f6169 100644 --- a/Eclipse-Setup.md +++ b/Eclipse-Setup.md @@ -37,7 +37,7 @@ Add the "bin" folder from wherever you install it to your environment's PATH var Create a new ANT_HOME environment variable that points to the folder containing the unzipped files. 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. +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 and Royale 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. E. Adobe Flash Player playerglobal.swc (Only required for SWF output) @@ -72,18 +72,23 @@ We are using Eclipse Helios for Java 1.6 compatibility because at least one of t ### Run/Debug Configurations -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): +The run/debug configuration for building a Royale application in Eclipse needs the following settings (Assuming the path to the royale-asjs repo is /Users/myusername/git/apache/royale/royale-asjs): + +Project: + +`compiler-jx` + +Main Class: + +`org.apache.royale.compiler.clients.MXMLJSC` Program Arguments: -+royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" -debug /Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/DataBindingExample.mxml +`+royalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" +configname=royale -debug /Users/myusername/git/apache/royale/royale-asjs/examples/royale/DataBindingExample/src/DataBindingExample.mxml` VM Arguments: --Xmx384m -Dsun.io.useCanonCaches=false -Droyalecompiler="/Users/myusername/git/apache/royale/royale-compiler/compiler" -Droyalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks" +`-Xmx384m -Dsun.io.useCanonCaches=false -Droyalelib="/Users/myusername/git/apache/royale/royale-asjs/frameworks"` -And the environment variables: +And the environment variables (Only required for SWF Output): 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 Royale Compiler the Program Arguments are: - -+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.
[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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 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
[royale-compiler.wiki] branch master updated: Updated Eclipse Setup (markdown)
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 70cff1b Updated Eclipse Setup (markdown) 70cff1b is described below commit 70cff1bb8ebbe9a894cffd395f7aa05f03d80ee5 Author: aharui AuthorDate: Sat Jun 2 23:02:24 2018 -0700 Updated Eclipse Setup (markdown) --- Eclipse-Setup.md | 16 +--- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/Eclipse-Setup.md b/Eclipse-Setup.md index efb2b3b..5962581 100644 --- a/Eclipse-Setup.md +++ b/Eclipse-Setup.md @@ -11,16 +11,18 @@ Setup of the royale-compiler project in Eclipse should be pretty straight-forwar 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. +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. + ### Setup Debug Configurations -This is the setup for developers working with the source code. If you only want to build applications with the Royale Compiler, see: Getting Started with the Royale Compiler. +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). First you will need the following prerequisites: A. 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 +`javac -version` The Java Compiler (javac) should print out its version if its already installed. If not, download and install a JDK from http://www.oracle.com/technetwork/java/javase/downloads/index.html. Then: Add the "bin" folder from wherever you installed it to your environment's PATH variable. @@ -31,15 +33,15 @@ 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 +C. 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 +D. 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 +E. 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. @@ -62,7 +64,7 @@ In the royale-compiler folder, run 'ant'. Using Eclipse -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
