Skip to content

Commit 63976b2

Browse files
committed
misc improvements to readme
1 parent 282f468 commit 63976b2

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Scala 2.11.x Distribution #
1+
# The Scala 2.11.x Distribution
22

33
This project morphs the `"org.scala-lang" % "scala-dist" % $version` maven artifact
44
into a Scala `$version` distribution (zip, tar.gz, deb, rpm, and msi).
@@ -7,46 +7,44 @@ To build a distribution, run:
77

88
* `universal:package-bin` - Builds the universal zip installer
99
* `universal-docs:package-bin` - Builds the universal documentation zip
10-
* `debian:package-bin` - Builds the debian DEB file. *Requires dpkg-deb*
10+
* `debian:package-bin` - Builds the Debian DEB file. *requires dpkg-deb*
1111
* `rpm:package-bin` - Builds the yum RPM file. *requires rpmbuild*
12-
* `windows:package-bin` - Builds the windows MSI. *Requires WIX 3.6 installed*
12+
* `windows:package-bin` - Builds the Windows MSI. *requires WiX 3.6*
1313

14-
Alternatively, the `s3-upload` task's mapping are configured based on the platform
15-
the installer is running on: on Windows, it builds the MSI; on another platform,
14+
Alternatively, the `s3-upload` task's mappings are configured based on the platform
15+
the installer is running on. On Windows, it builds the MSI; on another platform,
1616
it'll create and upload the other packages in the above list. (Use `s3Upload::mappings` for a dry-run.)
1717

1818
The version of Scala to package is derived from the most recent git tag,
1919
or you can specify it using `-Dproject.version`.
2020

21-
This packager only works for Scala 2.11 releases (starting with M8),
21+
This packager only works for Scala 2.11+ releases (starting with M8),
2222
as earlier ones did not publish the `scala-dist` artifact to maven.
2323

24-
Due to limited resources, the native packages are quite rudimental -- we welcome new maintainers!
24+
Due to limited resources, the native packages are quite rudimentary.
25+
We welcome new maintainers!
2526

2627
## Legacy
2728
If you're looking for the editor configurations that used to be in the tool-support directory, please see https://github.com/scala/scala-tool-support.
28-
They were moved out because they no longer ship with the Scala distribution (you're welcome to take over the scala-tool-support project!).
29+
They were moved out because they no longer ship with the Scala distribution. (New maintainers are welcome on the scala-tool-support project!)
2930

3031
The specification also used to be in this repo -- it is now a part of the main repository over at [scala/scala](https://github.com/scala/scala/tree/2.11.x/spec).
3132

3233
## Windows VM
33-
- install windows 7 professional N 64-bit, ensure network access to github
34-
- install oracle java 6 jdk
35-
- install wix v3.6 (reboot!)
36-
- download sbt launcher 0.13.1 from xsbt.org to c:\users\jenkins\Downloads
37-
- install git
38-
- configure the jenkins master's tool locations for
34+
- install Windows 7 professional N 64-bit, ensure network access to GitHub
35+
- install Oracle Java 6 JDK
36+
- install WiX v3.6 (reboot!)
37+
- download sbt launcher 0.13.1 from xsbt.org to `c:\users\jenkins\Downloads`
38+
- install Git
39+
- configure the Jenkins master's tool locations for
3940
- HOME
40-
- jdk path
41-
- git (path of git.exe)
41+
- JDK path
42+
- Git (path of git.exe)
4243
- sbt launch jar
4344

44-
4545
## Contributing ##
4646
Please read the [Scala Pull Request Policy](https://github.com/scala/scala/wiki/Pull-Request-Policy)
4747
and sign the [CLA](http://typesafe.com/contribute/cla/scala).
4848

4949
The branching structure mimics that of [scala/scala](https://github.com/scala/scala):
50-
master is the upcoming 2.11.0 release,
51-
and the 2.10.x branch is your target for 2.10.x features.
52-
50+
branches for 2.11.x, 2.12.x, etc.

0 commit comments

Comments
 (0)