summaryrefslogtreecommitdiff
path: root/doc/README
diff options
context:
space:
mode:
authorAdriaan Moors <adriaan.moors@typesafe.com>2013-12-13 22:23:54 -0800
committerAdriaan Moors <adriaan.moors@typesafe.com>2013-12-19 10:26:11 -0800
commit94ca91dd5f404015bdfa94e373ed94c284761a1d (patch)
treee28fad37679e3b26ddcfbd3d49c163e7ba002bf1 /doc/README
parent846d8d119514ba631c08235d2352bfa49821f265 (diff)
downloadscala-94ca91dd5f404015bdfa94e373ed94c284761a1d.tar.gz
scala-94ca91dd5f404015bdfa94e373ed94c284761a1d.tar.bz2
scala-94ca91dd5f404015bdfa94e373ed94c284761a1d.zip
Prepare maven-based distribution building.
NOTE: `maven/latest/build.xml` is now deprecated. To publish a Scala build, simply call `ant publish` or `ant publish-local`. `maven/latest/build.xml` will soon disappear from `dists/` The idea is that a Scala distribution is a simple repackaging of artifacts already available on maven. Already available: typical jars for the artifacts (classes, sources, scaladoc). To add: the bin/, doc/, and man/ directories. Thus, move the contents that should end up in the distribution from docs/ to doc/, create the man/ directory with the manpages, and include the scripts in bin/. Next up: package these directories in a jar and publish to maven, with a dependency on scala-library-all, scala-reflect and scala-compiler, for the jars that should end up in the distribution. Refactorings: - Pull filter-pom out from deploy-one. - Rename maven-base to dist.maven. - Set all properties in the init target (dist.maven)
Diffstat (limited to 'doc/README')
-rw-r--r--doc/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000000..29f64c9fef
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,36 @@
+Scala Distribution
+------------------
+
+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
+-----------
+
+- scala Scala interactive interpreter
+- scalac Scala compiler
+- fsc Scala resident compiler
+- scaladoc Scala API documentation generator
+- scalap Scala classfile decoder
+
+Run the command "scalac -help" to display the list of available
+compiler options.
+
+
+Installation
+------------
+
+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.
+
+
+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