Skip to content

Commit cea7de0

Browse files
committed
Merge pull request scala#4792 from SethTisue/round-of-readme-updates
misc upgrades to README
2 parents ae5f0de + 37f5713 commit cea7de0

File tree

4 files changed

+36
-45
lines changed

4 files changed

+36
-45
lines changed

README.md

+12-27
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,12 @@ P.S.: If you have some spare time to help out around here, we would be delighted
4040

4141
# Handy Links
4242
- [A wealth of documentation](http://docs.scala-lang.org)
43+
- [mailing lists](http://www.scala-lang.org/community/)
44+
- [Gitter room for Scala contributors](https://gitter.im/scala/contributors)
4345
- [Scala CI](https://scala-ci.typesafe.com/)
44-
- [Download the latest nightly](http://www.scala-lang.org/files/archive/nightly/2.11.x/)
45-
- [(Deprecated) Scala CI at EPFL](https://scala-webapps.epfl.ch/jenkins/)
46-
- Scala mailing lists:
47-
- [Compiler and standard library development](https://groups.google.com/group/scala-internals)
48-
- [Users of Scala](https://groups.google.com/group/scala-user)
49-
- [Scala language discussion](https://groups.google.com/group/scala-language)
50-
- [Scala Improvement Process](https://groups.google.com/group/scala-sips)
51-
- [Debate](https://groups.google.com/group/scala-debate)
52-
- [Announcements](https://groups.google.com/group/scala-announce)
46+
- download the latest nightlies:
47+
- [2.11.x](http://www.scala-lang.org/files/archive/nightly/2.11.x/)
48+
- [2.12.x](http://www.scala-lang.org/files/archive/nightly/2.12.x/)
5349

5450
# Repository structure
5551

@@ -74,7 +70,11 @@ scala/
7470

7571
## Requirements
7672

77-
You'll need a Java SDK (6 or newer), Apache Ant (version 1.9.0 or above), and curl (for `./pull-binary-libs.sh`).
73+
You'll need a Java SDK. The baseline version is 6 for 2.11.x, 8 for
74+
2.12.x. (It's also possible to use a later SDK for local development,
75+
but the CI will verify against the baseline version.)
76+
77+
You'll also need Apache Ant (version 1.9.0 or above) and curl (for `./pull-binary-libs.sh`).
7878

7979
## Git Hygiene
8080

@@ -129,25 +129,10 @@ Here, `<milestone>` is the milestone targeted by the PR (e.g., 2.11.6), and `<sh
129129

130130
## IDE Setup
131131
### Eclipse
132-
Download the [Scala IDE bundle](http://scala-ide.org/download/sdk.html). It comes preconfigured for optimal performance.
133-
134-
- Run `ant init` to download some necessary jars.
135-
- Import the project (in `src/eclipse`) via `File``Import Existing Projects into Workspace`. Check all projects and click ok.
136-
137-
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.
132+
See `src/eclipse/README.md`.
138133

139134
### IntelliJ 14
140-
Use the latest IntelliJ IDEA release and install the Scala plugin from within the IDE.
141-
142-
The following steps are required to use IntelliJ IDEA on Scala trunk
143-
- Run `ant init`. This will download some JARs to `./build/deps`, which are included in IntelliJ's classpath.
144-
- Run `./src/intellij/setup.sh`.
145-
- Open `./src/intellij/scala.ipr` in IntelliJ.
146-
- `File``Project Structure``Project``Project SDK`. Create an SDK entry named "1.6" containing the Java 1.6 SDK.
147-
(You may use a later SDK for local development, but the CI will verify against Java 6.)
148-
149-
Compilation within IDEA is performed in `-Dlocker.skip=1` mode: the sources are built
150-
directly using the STARR compiler (which is downloaded from [the Central Repository](http://central.sonatype.org/), according to `starr.version` in `versions.properties`).
135+
See `src/intellij/README.md`.
151136

152137
## Building with sbt (EXPERIMENTAL)
153138

src/eclipse/README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
Eclipse project files
22
=====================
33

4-
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).
4+
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).
55

6-
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`
7-
and navigate to `scala/src/eclipse`. Check all projects and click ok.
6+
The following points describe how to build Scala using Eclipse.
87

9-
0. You need to define a `path variable` inside Eclipse. Define `SCALA_BASEDIR` in
10-
`Preferences/General/Workspace/Linked Resources`. The value should be the absolute
8+
0. Download the [Scala IDE bundle](http://scala-ide.org/download/sdk.html). It comes preconfigured for optimal performance.
9+
10+
0. Run `ant init` to download some necessary jars.
11+
12+
0. Import the project (in `src/eclipse`) via `File``Import Existing Projects` and navigate to `scala/src/eclipse`. Check all projects and click ok.
13+
14+
0. You need to define a `path variable` inside Eclipse. Define `SCALA_BASEDIR` in
15+
`Preferences/General/Workspace/Linked Resources`. The value should be the absolute
1116
path to your Scala checkout. All paths in the project files are relative to this one,
1217
so nothing will work before you do so.
1318

@@ -29,7 +34,7 @@ JDK. The Scala library uses such APIs, so you'd see this error:
2934
Access restriction: The method compareAndSwapObject(Object, long, Object, Object)
3035
from the type Unsafe is not accessible due to restriction on required library.
3136

32-
You can *fix* it by allowing calls to restricted APIs in `Java/Compiler/Errors/Warnings/Deprecated and Restricted API`
37+
You can *fix* it by allowing calls to restricted APIs in `Java/Compiler/Errors/Warnings/Deprecated and Restricted API`
3338
settings.
3439

3540
0. Project files are tracked by Git, so adding them to `.gitignore` won't prevent them

src/intellij/README

-12
This file was deleted.

src/intellij/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Use the latest IntelliJ IDEA release and install the Scala plugin from within the IDE.
2+
3+
Compilation withing IDEA is performed in "-Dlocker.skip=1" mode: the sources are built
4+
directly using the STARR compiler.
5+
6+
The following steps are required to use IntelliJ IDEA on Scala trunk
7+
- Run `ant init`. This will download some JARs to `./build/deps`, which are included in IntelliJ's classpath.
8+
- Run `./src/intellij/setup.sh`.
9+
- Open `./src/intellij/scala.ipr` in IntelliJ.
10+
- `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.)
11+
12+
Compilation within IDEA is performed in `-Dlocker.skip=1` mode: the sources are built
13+
directly using the STARR compiler (which is downloaded from [the Central Repository](http://central.sonatype.org/), according to `starr.version` in `versions.properties`).

0 commit comments

Comments
 (0)