From d0c5e4be5554f4862da0690ac0315a4433fcb5d5 Mon Sep 17 00:00:00 2001 From: Paul Phillips Date: Sat, 30 Jul 2011 07:14:13 +0000 Subject: README updates, no review. --- README | 49 ++++++++++++++----------------------------------- 1 file changed, 14 insertions(+), 35 deletions(-) diff --git a/README b/README index 69b0c7532f..566ab853be 100644 --- a/README +++ b/README @@ -15,40 +15,27 @@ part of the Subversion repository but are either automatically generated by the build script or user-created if needed. This is not a complete listing. scala/ - bin/ Developer utilities. - build/ † Temporary staging area for build products. - build.excludes † An optional build configuration file. + build/ † Build products output directory for ant. build.number The version number of the current distribution. - build.properties † An optional build configuration file. build.xml The main Ant build script. - dist/ † The destination folder of Scala distributions. - docs/ Documentation of Scala. More in its own module. - development/ Developer documentation. - examples/ Scala source code examples. + dist/ † The destination folder for Scala distributions. + docs/ Documentation and sample code. lib/ Pre-compiled libraries for the build. fjbg.jar The Java byte-code generation library. - scala-compiler.jar The stable reference version (aka 'starr') - of the Scala compiler - scala-library.jar The stable reference version (aka 'starr') - of the Scala library. - scala-library-src.jar A snapshot of the source code which was used - to build starr. - ant/ Support libraries for the build tool. - ant-contrib.jar Provides additional features for Ant - vizant.jar Provides DOT graph generation for Ant - project/ All that is needed to use SBT for building - boot/ † SBT storage (for download,...) - build/ The class files that defines the build project - build.properties Various SBT project variables + scala-compiler.jar The stable reference ('starr') compiler jar + scala-library.jar The stable reference ('starr') library jar + scala-library-src.jar A snapshot of the source used to build starr. + ant/ Support libraries for ant. + project/ The (already legacy) 0.7 sbt build. README The file you are currently reading. - sandbox/ † A folder to test code etc. src/ All the source files of Scala. actors/ The sources of the Actor library. compiler/ The sources of the Scala compiler. library/ The sources of the core Scala library. swing/ The sources of the Swing library. - target/ † Temporary staging area for build products from the SBT script. + target/ † Build products output directory for sbt. test/ The Scala test suite. + tools/ Developer utilities. Part II. Building Scala with SABBUS -------------------------------------------------------------------------------- @@ -71,7 +58,7 @@ by starr to guarantee the bootstrapping of the compiler. 'locker': the local reference which is compiled by starr and is the work compiler in a typical development cycle. When it has been built once, it is “frozen” in this state. Updating it to fit the current source code must be -explicitly required (see below). +explicitly requested (see below). 'quick': the layer which is incrementally built when testing changes in the compiler or library. This is considered an actual new version when locker is @@ -96,12 +83,7 @@ assumed to be installed on the build machine: - Apache Ant version 1.7.0 or above. -Part III. Using SBT as an alternative --------------------------------------------------------------------------------- -It is now possible to use SBT as an alternative to build Scala. This is still in beta stage. -More informations and usage instruction at http://lampsvn.epfl.ch/trac/scala/wiki/SBT - -Part IV. Common use-cases +Part III. Common use-cases -------------------------------------------------------------------------------- 'ant -p' @@ -178,15 +160,12 @@ In detail: - Scala mailing lists: http://www.scala-lang.org/node/199 -- Scala Trac bug and issue tracker: - https://lampsvn.epfl.ch/trac/scala +- Scala bug and issue tracker: + https://issues.scala-lang.org - Scala live SVN source tree: http://www.scala-lang.org/node/213 -- Building Scala from the source code: - http://www.scala-lang.org/node/217 - - Contact form: http://www.scala-lang.org/node/188 -- cgit v1.2.3