diff options
| author | Seth Tisue <seth@tisue.net> | 2015-11-25 12:22:00 -0500 |
|---|---|---|
| committer | Seth Tisue <seth@tisue.net> | 2015-11-25 16:12:31 -0500 |
| commit | 4c9cf9dba9514255f67142874025d868ab33c1d8 (patch) | |
| tree | 9ab49660a86d7697e359e0fb7dc10b92b89c70f7 | |
| parent | 2ef93ad2fe29766fbe09a3e921ad361b25abdeaf (diff) | |
| download | scala-4c9cf9dba9514255f67142874025d868ab33c1d8.tar.gz scala-4c9cf9dba9514255f67142874025d868ab33c1d8.tar.bz2 scala-4c9cf9dba9514255f67142874025d868ab33c1d8.zip | |
IntelliJ README improvements
* fix typo (`withing`)
* fix repeated text about bootstrapping
* fix bad Markdown (no blank line before bullet list)
* generally rewrite/reformat/overhaul
| -rw-r--r-- | src/intellij/README.md | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/src/intellij/README.md b/src/intellij/README.md index 64e7b8188a..8717003441 100644 --- a/src/intellij/README.md +++ b/src/intellij/README.md @@ -1,13 +1,20 @@ -Use the latest IntelliJ IDEA release and install the Scala plugin from within the IDE. +# Building Scala using IntelliJ IDEA -Compilation withing IDEA is performed in "-Dlocker.skip=1" mode: the sources are built -directly using the STARR compiler. +## Requirements + +Use the latest IntelliJ release and install the Scala plugin from within the IDE. + +## Initial setup + +To create the IntelliJ project definition, -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.) + - In `File` → `Project Structure` → `Project` → `Project SDK`, create an SDK entry named "1.8" containing the Java 1.8 SDK. + +## Usage + +Compiling, running, and debugging should all work. You can work on the compiler, the standard library, and other components as well. -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`). +Note that compilation within IntelliJ is performed in `-Dlocker.skip=1` mode. Code is compiled not by bootstrapping the current compiler sources, but simply by using the "STARR" (stable reference) compiler, as specified by `starr.version` in `versions.properties`. |