legacy-svn-scala/docs
michelou 1172e73d26 updated contents of file docs/README in module 'scala'
git-svn-id: http://lampsvn.epfl.ch/svn-repos/scala/scala/trunk@6844 5e8d7ff9-d8ef-0310-90f0-a4852d11357a
2006-03-18 22:31:47 +00:00
..
development Remove files that were not required for compilation. Clean ignore patterns. 2006-03-03 17:28:53 +00:00
examples changed 'mixin class' into 'trait' in docs/examples/*.scala 2006-03-14 21:24:54 +00:00
man/man1 updated man pages for Scala 2 2006-03-10 21:37:12 +00:00
LICENSE - updated copyright notice (year, "unless specified otherwise") in file docs/LICENSE 2006-02-10 12:20:59 +00:00
README updated contents of file docs/README in module 'scala' 2006-03-18 22:31:47 +00:00
TODO 'TODO' files moves to 'docs'. 2005-12-16 18:48:00 +00:00

README

Scala Software Distributions
----------------------------

- scala-<major>.<minor>.<patch>.tar.bz2     Unis distribution
- scala-<major>.<minor>.<patch>.tar.gz      Unix distribution
- scala-<major>.<minor>.<patch>.zip         Windows distribution

The standard distributions require Java 1.4.x or above. If you don't
know which version of Java you have, run the command "java -version".


Scala Tools
-----------

- scalac      Scala compiler
- scaladoc    Scala API documentation generator
- scalaint    Scala interactive interpreter
- scalap      Scala classfile decoder 

Run the command "scalac -help" to display the list of available
compiler options.


Install on Unix
---------------

Untar the archive. All Scala tools are located in the directory "bin".
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/scalac share/doc/scala/examples/sort.scala
$ ./bin/scala examples.sort
[6,2,8,5,1]
[1,2,5,6,8]
$ ./bin/scalaint
scala> examples.sort.main(null)
[6,2,8,5,1]
[1,2,5,6,8]
scala>:quit
$


Install on Windows
------------------

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.

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.

set SCALA_HOME=<install-directory>\scala-YYYYMMDD-hhmmss

On Windows NT/2000/XP, you do not need to define any variable in order
for the Scala commands to run correctly.