diff options
| author | Adriaan Moors <adriaan.moors@typesafe.com> | 2013-12-09 11:48:49 -0800 |
|---|---|---|
| committer | Adriaan Moors <adriaan.moors@typesafe.com> | 2013-12-10 11:09:04 -0800 |
| commit | 27a38602decb891399fc9868b4dd7135f6e1ec2c (patch) | |
| tree | 6b8c80d8b9378c1d61ab90cbfc615ac8ea39d16c /docs/README | |
| parent | 139ba9d8759f325658f798de625676459a174a93 (diff) | |
| download | scala-27a38602decb891399fc9868b4dd7135f6e1ec2c.tar.gz scala-27a38602decb891399fc9868b4dd7135f6e1ec2c.tar.bz2 scala-27a38602decb891399fc9868b4dd7135f6e1ec2c.zip | |
Update README, include doc/licenses in distro
We forgot to copy the licenses directory to the dists/ directory,
so that they weren't included in the binary distribution.
I did some house cleaning while I was at it. We no longer distribute
ant as far as I can see (we used to for the sbt build,
but that was long since removed).
Added license for ASM, and Jansi (just to be sure).
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 58 |
1 files changed, 18 insertions, 40 deletions
diff --git a/docs/README b/docs/README index 6af633444d..1d5f553d2e 100644 --- a/docs/README +++ b/docs/README @@ -1,58 +1,36 @@ +Scala Distribution +------------------ -Scala Software Distributions ----------------------------- - -- scala-<major>.<minor>.<patch>.tgz Unix distribution -- scala-<major>.<minor>.<patch>.zip Windows distribution - -The standard distributions require Java 1.5 or above. If you don't -know which version of Java you have, run the command "java -version". +The Scala distribution requires Java 1.6 or above. +Please report bugs at https://issues.scala-lang.org/. +We welcome contributions at https://github.com/scala/scala! Scala Tools ----------- -- fsc Scala offline compiler +- scala Scala interactive interpreter - scalac Scala compiler +- fsc Scala resident compiler - scaladoc Scala API documentation generator -- scala Scala interactive interpreter - scalap Scala classfile decoder Run the command "scalac -help" to display the list of available compiler options. -Unix Installation ------------------ - -Untar the archive. All Scala tools are located in the "bin" directory. -Adding that directory to the PATH variable will make the Scala commands -directly accessible. - -You may test the distribution by running the following commands: - -$ ./bin/scala -scala> Array(4,3,2,1).sorted -res0: Array[Int] = Array(1, 2, 3, 4) - -scala>:quit -$ - - -Windows Installation --------------------- - -Unzip the archive. All Scala tools are located in the "bin" directory. -Adding that directory to the PATH variable will make the Scala commands -directly accessible. +Installation +------------ -On Windows 95/98/Me, you must define the environment variable SCALA_HOME -to point to the home directory of the Scala distribution to run any of -these tools. This can be done by adding the following command to your -AUTOEXEC.BAT file and then rebooting your machine. +Decompress the archive and run the above commands directly from `bin` directory. +We recommend adding the full path of the `bin` directory to the `PATH` +environment variable. -set SCALA_HOME=<install-directory>\scala-<major>.<minor>.<patch> -On Windows NT/2000/XP, you do not need to define any variable in order -for the Scala commands to run correctly. +Licenses +-------- +Scala is licensed under the standard 3-clause BSD license, +included in the distribution as the file `doc/LICENSE`. +The licenses of the software included in the Scala distribution can +be found in the `doc/licenses` directory.
\ No newline at end of file |