diff --git a/README.md b/README.md index 96d566fbd..7e4f0394b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# The Scala 2.11.x Distribution # +# The Scala 2.11.x Distribution This project morphs the `"org.scala-lang" % "scala-dist" % $version` maven artifact into a Scala `$version` distribution (zip, tar.gz, deb, rpm, and msi). @@ -7,46 +7,44 @@ To build a distribution, run: * `universal:package-bin` - Builds the universal zip installer * `universal-docs:package-bin` - Builds the universal documentation zip - * `debian:package-bin` - Builds the debian DEB file. *Requires dpkg-deb* + * `debian:package-bin` - Builds the Debian DEB file. *requires dpkg-deb* * `rpm:package-bin` - Builds the yum RPM file. *requires rpmbuild* - * `windows:package-bin` - Builds the windows MSI. *Requires WIX 3.6 installed* + * `windows:package-bin` - Builds the Windows MSI. *requires WiX 3.6* -Alternatively, the `s3-upload` task's mapping are configured based on the platform -the installer is running on: on Windows, it builds the MSI; on another platform, +Alternatively, the `s3-upload` task's mappings are configured based on the platform +the installer is running on. On Windows, it builds the MSI; on another platform, it'll create and upload the other packages in the above list. (Use `s3Upload::mappings` for a dry-run.) The version of Scala to package is derived from the most recent git tag, or you can specify it using `-Dproject.version`. -This packager only works for Scala 2.11 releases (starting with M8), +This packager only works for Scala 2.11+ releases (starting with M8), as earlier ones did not publish the `scala-dist` artifact to maven. -Due to limited resources, the native packages are quite rudimental -- we welcome new maintainers! +Due to limited resources, the native packages are quite rudimentary. +We welcome new maintainers! ## Legacy 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. -They were moved out because they no longer ship with the Scala distribution (you're welcome to take over the scala-tool-support project!). +They were moved out because they no longer ship with the Scala distribution. (New maintainers are welcome on the scala-tool-support project!) 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). ## Windows VM - - install windows 7 professional N 64-bit, ensure network access to github - - install oracle java 6 jdk - - install wix v3.6 (reboot!) - - download sbt launcher 0.13.1 from xsbt.org to c:\users\jenkins\Downloads - - install git - - configure the jenkins master's tool locations for + - install Windows 7 professional N 64-bit, ensure network access to GitHub + - install Oracle Java 6 JDK + - install WiX v3.6 (reboot!) + - download sbt launcher 0.13.1 from xsbt.org to `c:\users\jenkins\Downloads` + - install Git + - configure the Jenkins master's tool locations for - HOME - - jdk path - - git (path of git.exe) + - JDK path + - Git (path of git.exe) - sbt launch jar - ## Contributing ## Please read the [Scala Pull Request Policy](https://github.com/scala/scala/wiki/Pull-Request-Policy) and sign the [CLA](http://typesafe.com/contribute/cla/scala). The branching structure mimics that of [scala/scala](https://github.com/scala/scala): -master is the upcoming 2.11.0 release, -and the 2.10.x branch is your target for 2.10.x features. - +branches for 2.11.x, 2.12.x, etc.