diff options
| -rw-r--r-- | README.md | 39 | ||||
| -rw-r--r-- | src/eclipse/README.md | 17 | ||||
| -rw-r--r-- | src/intellij/README | 12 | ||||
| -rw-r--r-- | src/intellij/README.md | 13 |
4 files changed, 36 insertions, 45 deletions
@@ -40,16 +40,12 @@ P.S.: If you have some spare time to help out around here, we would be delighted # Handy Links - [A wealth of documentation](http://docs.scala-lang.org) + - [mailing lists](http://www.scala-lang.org/community/) + - [Gitter room for Scala contributors](https://gitter.im/scala/contributors) - [Scala CI](https://scala-ci.typesafe.com/) - - [Download the latest nightly](http://www.scala-lang.org/files/archive/nightly/2.11.x/) - - [(Deprecated) Scala CI at EPFL](https://scala-webapps.epfl.ch/jenkins/) - - Scala mailing lists: - - [Compiler and standard library development](https://groups.google.com/group/scala-internals) - - [Users of Scala](https://groups.google.com/group/scala-user) - - [Scala language discussion](https://groups.google.com/group/scala-language) - - [Scala Improvement Process](https://groups.google.com/group/scala-sips) - - [Debate](https://groups.google.com/group/scala-debate) - - [Announcements](https://groups.google.com/group/scala-announce) + - download the latest nightlies: + - [2.11.x](http://www.scala-lang.org/files/archive/nightly/2.11.x/) + - [2.12.x](http://www.scala-lang.org/files/archive/nightly/2.12.x/) # Repository structure @@ -74,7 +70,11 @@ scala/ ## Requirements -You'll need a Java SDK (6 or newer), Apache Ant (version 1.9.0 or above), and curl (for `./pull-binary-libs.sh`). +You'll need a Java SDK. The baseline version is 6 for 2.11.x, 8 for +2.12.x. (It's also possible to use a later SDK for local development, +but the CI will verify against the baseline version.) + +You'll also need Apache Ant (version 1.9.0 or above) and curl (for `./pull-binary-libs.sh`). ## Git Hygiene @@ -129,25 +129,10 @@ Here, `<milestone>` is the milestone targeted by the PR (e.g., 2.11.6), and `<sh ## IDE Setup ### Eclipse -Download the [Scala IDE bundle](http://scala-ide.org/download/sdk.html). It comes preconfigured for optimal performance. - - - Run `ant init` to download some necessary jars. - - Import the project (in `src/eclipse`) via `File` → `Import Existing Projects into Workspace`. Check all projects and click ok. - -For important details on building, debugging and file encodings, please see [the excellent tutorial on scala-ide.org](http://scala-ide.org/docs/tutorials/scalac-trunk/index.html) and the included README.md in src/eclipse. +See `src/eclipse/README.md`. ### IntelliJ 14 -Use the latest IntelliJ IDEA release and install the Scala plugin from within the IDE. - -The following steps are required to use IntelliJ IDEA on Scala trunk - - Run `ant init`. This will download some JARs to `./build/deps`, which are included in IntelliJ's classpath. - - Run `./src/intellij/setup.sh`. - - Open `./src/intellij/scala.ipr` in IntelliJ. - - `File` → `Project Structure` → `Project` → `Project SDK`. Create an SDK entry named "1.6" containing the Java 1.6 SDK. - (You may use a later SDK for local development, but the CI will verify against Java 6.) - -Compilation within IDEA is performed in `-Dlocker.skip=1` mode: the sources are built -directly using the STARR compiler (which is downloaded from [the Central Repository](http://central.sonatype.org/), according to `starr.version` in `versions.properties`). +See `src/intellij/README.md`. ## Building with sbt (EXPERIMENTAL) diff --git a/src/eclipse/README.md b/src/eclipse/README.md index 03c7403b04..fe2c109402 100644 --- a/src/eclipse/README.md +++ b/src/eclipse/README.md @@ -1,13 +1,18 @@ Eclipse project files ===================== -The following points describe how to get Scala to run in Eclipse. Please also take a look at the [excellent tutorial on scala-ide.org](http://scala-ide.org/docs/tutorials/scalac-trunk/index.html). +For important details on building, debugging and file encodings, please see [the excellent tutorial on scala-ide.org](http://scala-ide.org/docs/tutorials/scalac-trunk/index.html). -0. Import all projects into a [very recent version of Scala IDE for Eclipse](http://scala-ide.org/download/nightly.html) by choosing `File/Import Existing Projects` -and navigate to `scala/src/eclipse`. Check all projects and click ok. +The following points describe how to build Scala using Eclipse. -0. You need to define a `path variable` inside Eclipse. Define `SCALA_BASEDIR` in -`Preferences/General/Workspace/Linked Resources`. The value should be the absolute +0. Download the [Scala IDE bundle](http://scala-ide.org/download/sdk.html). It comes preconfigured for optimal performance. + +0. Run `ant init` to download some necessary jars. + +0. Import the project (in `src/eclipse`) via `File` → `Import Existing Projects` and navigate to `scala/src/eclipse`. Check all projects and click ok. + +0. You need to define a `path variable` inside Eclipse. Define `SCALA_BASEDIR` in +`Preferences/General/Workspace/Linked Resources`. The value should be the absolute path to your Scala checkout. All paths in the project files are relative to this one, so nothing will work before you do so. @@ -29,7 +34,7 @@ JDK. The Scala library uses such APIs, so you'd see this error: Access restriction: The method compareAndSwapObject(Object, long, Object, Object) from the type Unsafe is not accessible due to restriction on required library. - You can *fix* it by allowing calls to restricted APIs in `Java/Compiler/Errors/Warnings/Deprecated and Restricted API` + You can *fix* it by allowing calls to restricted APIs in `Java/Compiler/Errors/Warnings/Deprecated and Restricted API` settings. 0. Project files are tracked by Git, so adding them to `.gitignore` won't prevent them diff --git a/src/intellij/README b/src/intellij/README deleted file mode 100644 index 4ecab5561f..0000000000 --- a/src/intellij/README +++ /dev/null @@ -1,12 +0,0 @@ -Use the latest IntelliJ IDEA release and install the Scala plugin from within the IDE. - -Compilation withing IDEA is performed in "-Dlocker.skip=1" mode: the sources are built -directly using the STARR compiler. - -The following steps are required to use IntelliJ IDEA on Scala trunk - - Run "ant init". This will download some JARs from to ./build/deps, which are - included in IntelliJ's classpath. - - Run src/intellij/setup.sh - - Open ./src/intellij/scala.ipr in IntelliJ - - File, Project Settings, Project, SDK. Create an SDK entry named "1.6" containing the - Java 1.6 SDK diff --git a/src/intellij/README.md b/src/intellij/README.md new file mode 100644 index 0000000000..64e7b8188a --- /dev/null +++ b/src/intellij/README.md @@ -0,0 +1,13 @@ +Use the latest IntelliJ IDEA release and install the Scala plugin from within the IDE. + +Compilation withing IDEA is performed in "-Dlocker.skip=1" mode: the sources are built +directly using the STARR compiler. + +The following steps are required to use IntelliJ IDEA on Scala trunk + - Run `ant init`. This will download some JARs to `./build/deps`, which are included in IntelliJ's classpath. + - Run `./src/intellij/setup.sh`. + - Open `./src/intellij/scala.ipr` in IntelliJ. + - `File` → `Project Structure` → `Project` → `Project SDK`. Create an SDK entry named "1.6" containing the Java 1.6 SDK. (Or other SDK version; see "Requirements" in the repo's main README.) + +Compilation within IDEA is performed in `-Dlocker.skip=1` mode: the sources are built +directly using the STARR compiler (which is downloaded from [the Central Repository](http://central.sonatype.org/), according to `starr.version` in `versions.properties`). |