mirror of https://github.com/sbt/sbt.git
Give Getting Started Guide its own sidebar.
For now this involves a big cut-and-paste from the parent sidebar, but as we move each sidebar section into a subdirectory, the cut and paste will be minimized.
Havoc Pennington
parent
8716a9af66
commit
8eae342910
|
|
@ -0,0 +1,28 @@
|
|||
# Welcome!
|
||||
|
||||
This Getting Started Guide will get you started with sbt.
|
||||
|
||||
sbt uses a small number of concepts to support flexible and
|
||||
powerful build definitions. There are not that many concepts, but
|
||||
sbt is not exactly like other build systems and there are details
|
||||
you _will_ stumble on if you haven't read the documentation.
|
||||
|
||||
The Getting Started Guide covers the concepts you need to know to
|
||||
create and maintain an sbt build definition.
|
||||
|
||||
It is _highly recommended_ to read the Getting Started Guide!
|
||||
|
||||
If you are in a huge hurry, the most important conceptual
|
||||
background can be found in
|
||||
[[basic build definition|Getting Started Basic Def]],
|
||||
[[scopes|Getting Started Scopes]], and
|
||||
[[more about settings|Getting Started More About Settings]]. But
|
||||
we don't promise that it's a good idea to skip the other pages in
|
||||
the guide.
|
||||
|
||||
It's best to read in order, as later pages in the Getting Started
|
||||
Guide build on concepts introduced earlier.
|
||||
|
||||
The guide begins with [[Setup|Getting Started Setup]].
|
||||
|
||||
Thanks for trying out sbt and _have fun_!
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
* [[Home]] - Overview of sbt
|
||||
* [[Getting Started|Getting Started Welcome]]
|
||||
* [[Setup|Getting Started Setup]] - Install sbt
|
||||
* [[Hello, World|Getting Started Hello]] - Create a simple project
|
||||
* [[Directory Layout|Getting Started Directories]] - Basic project layout
|
||||
* [[Running|Getting Started Running]] - The command line and interactive mode
|
||||
* [[Basic Build Definition|Getting Started Basic Def]] - Understanding build.sbt settings
|
||||
* [[Scopes|Getting Started Scopes]] - Put settings in context
|
||||
* [[More About Settings|Getting Started More About Settings]] - Settings based on other settings
|
||||
* [[Library Dependencies|Getting Started Library Dependencies]] - Adding jars or managed dependencies
|
||||
* [[Full Build Definition|Getting Started Full Def]] - When build.sbt is not enough
|
||||
* [[Using Plugins|Getting Started Using Plugins]] - Adding plugins to the build
|
||||
* [[Multi-Project Builds|Getting Started Multi-Project]] - Adding sub-projects to the build
|
||||
* [[Custom Settings and Tasks|Getting Started Custom Settings]] - Intro to extending sbt
|
||||
* [[Summary|Getting Started Summary]] - What you should know now
|
||||
* Help
|
||||
* [[Migrating from sbt 0.7.x to 0.10.x]]
|
||||
* [[Index]] - Look up common types, values, and methods
|
||||
* [[FAQ]]
|
||||
* Usage
|
||||
* [[Triggered Execution]]
|
||||
* [[Cross Build]]
|
||||
* [[Console Project]]
|
||||
* [[Inspecting Settings]]
|
||||
* [[Running Project Code]]
|
||||
* [[sbt Plugins List|sbt 0.10 Plugins List]]
|
||||
* Configuration
|
||||
* [[Settings]]
|
||||
* [[Basic Configuration]]
|
||||
* [[Full Configuration]]
|
||||
* [[Global Settings]]
|
||||
* Examples
|
||||
* [[Quick|Quick Configuration Examples]]
|
||||
* [[Full|Full Configuration Example]]
|
||||
* [[Advanced Command Example]]
|
||||
* [[Advanced Configurations Example]]
|
||||
* Managed Dependencies
|
||||
* [[Basic|Library Management]]
|
||||
* [[Configurations]]
|
||||
* [[Defining Repositories|Resolvers]]
|
||||
* [[Publishing]]
|
||||
* [[Artifacts]]
|
||||
* [[Update Report]]
|
||||
* [[Testing]]
|
||||
* [[Forking]]
|
||||
* [[Java Sources]]
|
||||
* [[Local Scala]]
|
||||
* Using [[Compiler Plugins]]
|
||||
* [[Plugins]] - Extending sbt
|
||||
* Tasks and Commands
|
||||
* Basic Constructs
|
||||
* [[Task|Tasks]]
|
||||
* [[Input Tasks]]
|
||||
* [[Commands]]
|
||||
* [[Common Tasks]]
|
||||
* [[Parsing Input]]
|
||||
* [[Build State]]
|
||||
* Paths and I/O
|
||||
* [[Paths]]
|
||||
* [[Classpaths, sources, and resources|Classpaths]]
|
||||
* [[Mapping Files]]
|
||||
* [[External Processes|Process]]
|
||||
* [[Specialized Tasks|Specialized]]
|
||||
* Guidelines
|
||||
* [[Task Inputs/Dependencies|TaskInputs]] - How to connect tasks together
|
||||
* [[General Best Practices|Best Practices]]
|
||||
* [[Plugin Best Practices|Plugins Best Practices]]
|
||||
* Other Modes
|
||||
* [[Launcher]] - Using the launcher for booting Scala applications
|
||||
* [[Scripts]] and REPL with dependencies
|
||||
* Project Information
|
||||
* [[Credits]]
|
||||
* [[Changes]]
|
||||
* [[Source code|https://github.com/harrah/xsbt/tree/0.11]]
|
||||
* [[License|https://github.com/harrah/xsbt/blob/0.11/LICENSE]]
|
||||
* [[API Documentation|http://harrah.github.com/xsbt/latest/api/index.html]]
|
||||
* [[SXR Documentation|http://harrah.github.com/xsbt/latest/sxr/index.html]]
|
||||
* [[Opportunities]]
|
||||
* [[Nightly Builds]]
|
||||
13
Home.md
13
Home.md
|
|
@ -18,14 +18,13 @@ sbt is a build tool for Scala and Java projects that aims to do the basics well.
|
|||
|
||||
## Getting Started
|
||||
|
||||
To get started, start with [[Setup|Getting Started Setup]], and continue through the other Getting
|
||||
Started pages listed in the sidebar on the right. It's best to read in
|
||||
order, as later pages in the Getting Started series build on concepts
|
||||
introduced earlier.
|
||||
To get started, read the
|
||||
[[Getting Started Guide|Getting Started Welcome]].
|
||||
|
||||
_Please read the Getting Started pages._ You will save yourself a _lot_ of
|
||||
time if you have the right understanding of the big picture
|
||||
up-front. [[Start with setup|Getting Started Setup]].
|
||||
_Please read the
|
||||
[[Getting Started Guide|Getting Started Welcome]]._ You will save
|
||||
yourself a _lot_ of time if you have the right understanding of
|
||||
the big picture up-front.
|
||||
|
||||
If you are familiar with 0.7.x, please see the
|
||||
[[migration page|Migrating from sbt 0.7.x to 0.10.x]]. Documentation for
|
||||
|
|
|
|||
15
_Sidebar.md
15
_Sidebar.md
|
|
@ -1,18 +1,5 @@
|
|||
* [[Home]] - Overview of sbt
|
||||
* Getting Started
|
||||
* [[Setup|Getting Started Setup]] - Install sbt
|
||||
* [[Hello, World|Getting Started Hello]] - Create a simple project
|
||||
* [[Directory Layout|Getting Started Directories]] - Basic project layout
|
||||
* [[Running|Getting Started Running]] - The command line and interactive mode
|
||||
* [[Basic Build Definition|Getting Started Basic Def]] - Understanding build.sbt settings
|
||||
* [[Scopes|Getting Started Scopes]] - Put settings in context
|
||||
* [[More About Settings|Getting Started More About Settings]] - Settings based on other settings
|
||||
* [[Library Dependencies|Getting Started Library Dependencies]] - Adding jars or managed dependencies
|
||||
* [[Full Build Definition|Getting Started Full Def]] - When build.sbt is not enough
|
||||
* [[Using Plugins|Getting Started Using Plugins]] - Adding plugins to the build
|
||||
* [[Multi-Project Builds|Getting Started Multi-Project]] - Adding sub-projects to the build
|
||||
* [[Custom Settings and Tasks|Getting Started Custom Settings]] - Intro to extending sbt
|
||||
* [[Summary|Getting Started Summary]] - What you should know now
|
||||
* [[Getting Started|Getting Started Welcome]] - START HERE
|
||||
* Help
|
||||
* [[Migrating from sbt 0.7.x to 0.10.x]]
|
||||
* [[Index]] - Look up common types, values, and methods
|
||||
|
|
|
|||
Loading…
Reference in New Issue