From 77c7e8b6ef00768fa2b29e0c3ae75ed811d1c544 Mon Sep 17 00:00:00 2001 From: Mark Harrah Date: Fri, 27 May 2011 23:19:38 -0400 Subject: [PATCH] trying for a sidebar and organized home page --- Home.md | 20 +++++++++++++++ JavaSources.md => Java-Sources.md | 0 _Sidebar.md | 41 +++++++++++++++++++++++++++++++ 3 files changed, 61 insertions(+) create mode 100644 Home.md rename JavaSources.md => Java-Sources.md (100%) create mode 100644 _Sidebar.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..76d52e5 --- /dev/null +++ b/Home.md @@ -0,0 +1,20 @@ +sbt is a build tool for Scala projects that aims to do the basics well. It requires Java 1.6 or later. + +## Features +* Fairly fast, unintrusive, and easy to set up for simple projects +* [[Configuration|Basic Configuration]], [[customization|Tasks]], and [[extension|Plugins]] are done in Scala +* Accurate recompilation (in theory) is done using information extracted from the compiler +* Continuous compilation and testing with [[triggered execution|Triggered Execution]] +* Supports mixed Scala/[[Java|Java Sources]] projects, packages jars, generates documentation with scaladoc +* Supports [[Testing|testing]] with ScalaCheck, specs, and ScalaTest (JUnit is supported by a plugin) +* Starts the Scala REPL with project classes and dependencies on the classpath +* [[Multi-module and external project|Full Configuration]] support +* Parallel task execution, including parallel test execution +* [[Dependency management support|Library Management]]: inline declarations, external Ivy or Maven configuration files, or manual management + +## Getting Started +To get started, read [[Setup]], [[Running]], [[Basic Configuration]], and [[Full Configuration]]. If you are familiar with 0.7.x, please see the [[migration page|Migrating from sbt 0.7.x to 0.9.x]]. + +The mailing list is at . Please use it for questions and comments! + +This wiki is editable if you have a github account. Feel free to make corrections and add documentation. Use the mailing list if you have questions or comments. diff --git a/JavaSources.md b/Java-Sources.md similarity index 100% rename from JavaSources.md rename to Java-Sources.md diff --git a/_Sidebar.md b/_Sidebar.md new file mode 100644 index 0000000..79b7982 --- /dev/null +++ b/_Sidebar.md @@ -0,0 +1,41 @@ +* Getting Started + * [[Setup]] - Getting sbt running on your machine + * [[Running]] - Using sbt from the command line + * [[Migrating from sbt 0.7.x to 0.9.x]] +* Usage + * [[Triggered Execution]] + * [[Cross Build]] + * [[Console Project]] + * [[Inspecting Settings]] + * [[Running Project Code]] +* Configuration + * [[Basic Configuration]] + * [[Examples|Quick Configuration Examples]] + * [[Full Configuration]] + * Managed Dependencies + * [[Basic|Library Management]] + * [[Configurations]] + * [[Defining Repositories|Resolvers]] + * [[Publishing]] + * [[Artifacts]] + * [[Update Report]] + * [[Forking]] + * [[Testing]] + * [[Java Sources]] + * [[Local Scala]] + * [[Tasks]] + * [[Classpaths]] + * [[External Processes|Process]] + * Using [[Compiler Plugins]] + * [[Plugins]] - Extending sbt + * [[Commands]] +* Project Information + * [[Credits]] + * [[Changes]] + * [[Source code|https://github.com/harrah/xsbt/tree/0.9]] + * [[License|https://github.com/harrah/xsbt/blob/0.9/LICENSE]] + * [[API Documentation|http://harrah.github.com/xsbt/latest/api/index.html]] + * [[SXR Documentation|http://harrah.github.com/xsbt/latest/sxr/index.html]] + * [[Opportunities]] + +