luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Alexandre Archambault 2016-01-07 09:39:40 +01:00
parent abff8d5bf3
commit 20febe7093
2 changed files with 24 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -53,14 +53,6 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [
## Quick start ## Quick start
The default global cache used by coursier is `~/.coursier/cache/v1`. E.g. the artifact at
`https://repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`
will land in `~/.coursier/cache/v1/https/repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`.
From the SBT plugin, the default repositories are the ones provided by SBT (typically Central or JFrog, and `~/.ivy2/local`).
From the CLI tools, these are Central (`https://repo1.maven.org/maven2`) and `~/.ivy2/local`.
From the API, these are specified manually - you are encouraged to use those too.
* SBT plugin * SBT plugin
Enable the SBT plugin by adding Enable the SBT plugin by adding
@ -160,6 +152,15 @@ val localArtifacts: Seq[FileError \/ File] = Task.gatherUnordered(
``` ```
The default global cache used by coursier is `~/.coursier/cache/v1`. E.g. the artifact at
`https://repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`
will land in `~/.coursier/cache/v1/https/repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`.
From the SBT plugin, the default repositories are the ones provided by SBT (typically Central or JFrog, and `~/.ivy2/local`).
From the CLI tools, these are Central (`https://repo1.maven.org/maven2`) and `~/.ivy2/local`.
From the API, these are specified manually - you are encouraged to use those too.
## Why ## Why
The current state of dependency management in Scala suffers several flaws, that prevent applications to fully The current state of dependency management in Scala suffers several flaws, that prevent applications to fully
@ -233,12 +234,10 @@ Both command belows can be given repositories with the `-r` or `--repository` op
``` ```
`central` and `ivy2local` correspond to Maven Central and `~/.ivy2/local`. These are used by default `central` and `ivy2local` correspond to Maven Central and `~/.ivy2/local`. These are used by default
if no `-r` or `--repository` option is specified. unless the `--no-default` option is specified.
As soon as a `-r` or `--repository` option is specified, these default are not used any more - only the
specified repositories are used.
Repositories starting with `ivy:` are assumed to be Ivy repositories, specified with an Ivy pattern. Else, Repositories starting with `ivy:` are assumed to be Ivy repositories, specified with an Ivy pattern, like `ivy:https://repo.typesafe.com/typesafe/ivy-releases/[organisation]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext]`.
a Maven repository is assumed. Else, a Maven repository is assumed.
#### launch #### launch

25
doc/README.md
View File

@ -53,14 +53,6 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [
## Quick start ## Quick start
The default global cache used by coursier is `~/.coursier/cache/v1`. E.g. the artifact at
`https://repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`
will land in `~/.coursier/cache/v1/https/repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`.
From the SBT plugin, the default repositories are the ones provided by SBT (typically Central or JFrog, and `~/.ivy2/local`).
From the CLI tools, these are Central (`https://repo1.maven.org/maven2`) and `~/.ivy2/local`.
From the API, these are specified manually - you are encouraged to use those too.
* SBT plugin * SBT plugin
Enable the SBT plugin by adding Enable the SBT plugin by adding
@ -160,6 +152,15 @@ val localArtifacts: Seq[FileError \/ File] = Task.gatherUnordered(
``` ```
The default global cache used by coursier is `~/.coursier/cache/v1`. E.g. the artifact at
`https://repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`
will land in `~/.coursier/cache/v1/https/repo1.maven.org/maven2/org/scala-lang/scala-library/2.11.7/scala-library-2.11.7.jar`.
From the SBT plugin, the default repositories are the ones provided by SBT (typically Central or JFrog, and `~/.ivy2/local`).
From the CLI tools, these are Central (`https://repo1.maven.org/maven2`) and `~/.ivy2/local`.
From the API, these are specified manually - you are encouraged to use those too.
## Why ## Why
The current state of dependency management in Scala suffers several flaws, that prevent applications to fully The current state of dependency management in Scala suffers several flaws, that prevent applications to fully
@ -234,12 +235,10 @@ Both command belows can be given repositories with the `-r` or `--repository` op
``` ```
`central` and `ivy2local` correspond to Maven Central and `~/.ivy2/local`. These are used by default `central` and `ivy2local` correspond to Maven Central and `~/.ivy2/local`. These are used by default
if no `-r` or `--repository` option is specified. unless the `--no-default` option is specified.
As soon as a `-r` or `--repository` option is specified, these default are not used any more - only the
specified repositories are used.
Repositories starting with `ivy:` are assumed to be Ivy repositories, specified with an Ivy pattern. Else, Repositories starting with `ivy:` are assumed to be Ivy repositories, specified with an Ivy pattern, like `ivy:https://repo.typesafe.com/typesafe/ivy-releases/[organisation]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext]`.
a Maven repository is assumed. Else, a Maven repository is assumed.
#### launch #### launch