legacy-svn-scala/docs
dubochet 775567ff72 Removed old Scalac code in sources and various other obsolete elements.
git-svn-id: http://lampsvn.epfl.ch/svn-repos/scala/scala/trunk@5387 5e8d7ff9-d8ef-0310-90f0-a4852d11357a
2005-12-18 18:33:03 +00:00
..
development Created proper 'docs' folder for new layout. 2005-12-16 18:44:33 +00:00
examples Created proper 'docs' folder for new layout. 2005-12-16 18:44:33 +00:00
man/man1 Removed old Scalac code in sources and various other obsolete elements. 2005-12-18 18:33:03 +00:00
LICENSE Created proper 'docs' folder for new layout. 2005-12-16 18:44:33 +00:00
README Created proper 'docs' folder for new layout. 2005-12-16 18:44:33 +00:00
TODO 'TODO' files moves to 'docs'. 2005-12-16 18:48:00 +00:00

README

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

- scala-YYYYMMDD-hhmmss.tar.gz            Unix distribution
- scala-YYYYMMDD-hhmmss.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
- scalarun    Scala interpreter
- scalap      Scala profiler

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

NB. socos, siris and surus are deprecated commands starting from
version 20030811-115735 of the Scala distribution, please use
respectively scalac, scalaint and scalarun instead.


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

Untar the archive. All Scala tools are located in the directory "bin".

You may test the distribution by running the script "scala-test"
located in the subdirectory "share/scala/test/bin".


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

Unzip the archive. All Scala tools are located in the "bin"
directory. Before running any of these tools, you must define the
environment variable SCALA_HOME to point to the home directory of the
scala distribution.

On Windows 95/98/Me, 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, open the "Control Panel", open the "System"
applet, select the "Advanced" tab, click on "Environment Variables",
click on "New..." in the user variable section and enter the following
informations:

Variable Name : SCALA_HOME
Variable Value: <install-directory>\scala-YYYYMMDD-hhmmss

If you have Administrator privileges, you may install the tools for
all users of your machine by creating a new system variable instead of
a new user variable.