diff --git a/README b/README deleted file mode 100644 index 840cf97cd..000000000 --- a/README +++ /dev/null @@ -1,2 +0,0 @@ -This is a script for running sbt 0.10, and a template sbt project. - diff --git a/README.md b/README.md new file mode 100644 index 000000000..bafdfc263 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +An alternative script for running [[sbt 0.10|https://github.com/harrah/xsbt]]. + + ./sbt -help + +Usage: sbt [options] + + -help prints this message + -nocolor disable ANSI color codes + -debug set sbt log level to debug + -sbtdir location of global settings and plugins (default: ~/.sbt) + -ivy local Ivy repository (default: ~/.ivy2) + -shared shared sbt boot directory (default: none, no sharing) + + # setting scala version + -28 set scala version to 2.8.1 + -29 set scala version to 2.9.0-1 + -210 set scala version to 2.10.0-SNAPSHOT + -local set scala version to local installation at path + + # passing options to jvm + JAVA_OPTS environment variable # default: "-Dfile.encoding=UTF8" + SBT_OPTS environment variable # default: "-XX:+CMSClassUnloadingEnabled -XX:MaxPermSize=512m -Xmx2g -Xss2m" + -Dkey=val pass -Dkey=val directly to the jvm + -J-X pass option -X directly to the jvm (-J is stripped) + +The defaults list for JAVA_OPTS and SBT_OPTS are only given if the +corresponding variable is unset. In the case of a duplicated option, +SBT_OPTS takes precedence over JAVA_OPTS, and command line options +take precedence over both. diff --git a/lib/README b/lib/README index 46e4a96f1..6e3f9b576 100644 --- a/lib/README +++ b/lib/README @@ -1 +1 @@ -sbt-launch.jar to be downloaded into here. \ No newline at end of file +sbt-launch.jar is downloaded into here.