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

Update README for 1.0.0-M13

This commit is contained in:
Alexandre Archambault 2016-08-11 15:45:23 -04:00
parent 0b2f5da5fa
commit 708c56d4e7
No known key found for this signature in database
GPG Key ID: 14640A6839C263A9
2 changed files with 18 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -73,7 +73,7 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [
Enable the SBT plugin by adding Enable the SBT plugin by adding
```scala ```scala
addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M12") addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M13")
``` ```
to `~/.sbt/0.13/plugins/build.sbt` (enables it globally), or to the `project/plugins.sbt` file to `~/.sbt/0.13/plugins/build.sbt` (enables it globally), or to the `project/plugins.sbt` file
of a SBT project. Tested with SBT 0.13.8 / 0.13.9. of a SBT project. Tested with SBT 0.13.8 / 0.13.9.
@ -111,8 +111,8 @@ $ ./coursier fetch org.apache.spark:spark-sql_2.11:1.6.1 com.twitter:algebird-sp
Add to your `build.sbt` Add to your `build.sbt`
```scala ```scala
libraryDependencies ++= Seq( libraryDependencies ++= Seq(
"io.get-coursier" %% "coursier" % "1.0.0-M12", "io.get-coursier" %% "coursier" % "1.0.0-M13",
"io.get-coursier" %% "coursier-cache" % "1.0.0-M12" "io.get-coursier" %% "coursier-cache" % "1.0.0-M13"
) )
``` ```
@ -215,7 +215,7 @@ of the cache used by a particular project, in case you have any doubt about what
Enable the SBT plugin globally by adding Enable the SBT plugin globally by adding
```scala ```scala
addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M12") addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M13")
``` ```
to `~/.sbt/0.13/plugins/build.sbt` to `~/.sbt/0.13/plugins/build.sbt`
@ -228,18 +228,6 @@ provide more output about what's going on than their default implementations do.
TEMPORARY As of the `1.0.0-M12` version, the SBT plugin doesn't re-use the `credentials` setting from SBT yet.
To enable credentials for a repository, add its credentials to `coursierCredentials`, like
```scala
resolvers += "corp-releases" at "http://nexus.corp.com/content/repositories/releases"
coursierCredentials += "corp-releases" -> coursier.Credentials("user", "pass")
// alternatively, read credentials from a file
coursierCredentials += "corp-releases" -> coursier.Credentials(file("path/to/credentials"))
```
Future versions of the plugin should support the `credentials` setting out-of-the-box.
### Command-line ### Command-line
Download and run its laucher with Download and run its laucher with
@ -380,7 +368,7 @@ The `bootstrap` generates tiny bootstrap launchers, able to pull their dependenc
repositories on first launch. For example, the launcher of coursier is [generated](https://github.com/alexarchambault/coursier/blob/master/project/generate-launcher.sh) with a command like repositories on first launch. For example, the launcher of coursier is [generated](https://github.com/alexarchambault/coursier/blob/master/project/generate-launcher.sh) with a command like
``` ```
$ ./coursier bootstrap \ $ ./coursier bootstrap \
io.get-coursier:coursier-cli_2.11:1.0.0-M12 \ io.get-coursier:coursier-cli_2.11:1.0.0-M13 \
-b -f -o coursier \ -b -f -o coursier \
-M coursier.cli.Coursier -M coursier.cli.Coursier
``` ```
@ -392,12 +380,12 @@ See `./coursier bootstrap --help` for a list of the available options.
Add to your `build.sbt` Add to your `build.sbt`
```scala ```scala
libraryDependencies ++= Seq( libraryDependencies ++= Seq(
"io.get-coursier" %% "coursier" % "1.0.0-M12", "io.get-coursier" %% "coursier" % "1.0.0-M13",
"io.get-coursier" %% "coursier-cache" % "1.0.0-M12" "io.get-coursier" %% "coursier-cache" % "1.0.0-M13"
) )
``` ```
The first module, `"io.get-coursier" %% "coursier" % "1.0.0-M12"`, mainly depends on The first module, `"io.get-coursier" %% "coursier" % "1.0.0-M13"`, mainly depends on
`scalaz-core` (and only it, *not* `scalaz-concurrent` for example). It contains among others, `scalaz-core` (and only it, *not* `scalaz-concurrent` for example). It contains among others,
definitions, definitions,
mainly in [`Definitions.scala`](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala), mainly in [`Definitions.scala`](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala),
@ -407,7 +395,7 @@ that expects to be given metadata, wrapped in any `Monad`, then feeds these to `
you the final `Resolution`, wrapped in the same `Monad` it was given input. This final `Resolution` has all the dependencies, you the final `Resolution`, wrapped in the same `Monad` it was given input. This final `Resolution` has all the dependencies,
including the transitive ones. including the transitive ones.
The second module, `"io.get-coursier" %% "coursier-cache" % "1.0.0-M12"`, is precisely in charge of fetching The second module, `"io.get-coursier" %% "coursier-cache" % "1.0.0-M13"`, is precisely in charge of fetching
these input metadata. It uses `scalaz.concurrent.Task` as a `Monad` to wrap them. It also fetches artifacts (JARs, etc.). these input metadata. It uses `scalaz.concurrent.Task` as a `Monad` to wrap them. It also fetches artifacts (JARs, etc.).
It caches all of these (metadata and artifacts) on disk, and validates checksums too. It caches all of these (metadata and artifacts) on disk, and validates checksums too.

30
doc/README.md
View File

@ -73,7 +73,7 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [
Enable the SBT plugin by adding Enable the SBT plugin by adding
```scala ```scala
addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M12") addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M13")
``` ```
to `~/.sbt/0.13/plugins/build.sbt` (enables it globally), or to the `project/plugins.sbt` file to `~/.sbt/0.13/plugins/build.sbt` (enables it globally), or to the `project/plugins.sbt` file
of a SBT project. Tested with SBT 0.13.8 / 0.13.9. of a SBT project. Tested with SBT 0.13.8 / 0.13.9.
@ -111,8 +111,8 @@ $ ./coursier fetch org.apache.spark:spark-sql_2.11:1.6.1 com.twitter:algebird-sp
Add to your `build.sbt` Add to your `build.sbt`
```scala ```scala
libraryDependencies ++= Seq( libraryDependencies ++= Seq(
"io.get-coursier" %% "coursier" % "1.0.0-M12", "io.get-coursier" %% "coursier" % "1.0.0-M13",
"io.get-coursier" %% "coursier-cache" % "1.0.0-M12" "io.get-coursier" %% "coursier-cache" % "1.0.0-M13"
) )
``` ```
@ -242,7 +242,7 @@ of the cache used by a particular project, in case you have any doubt about what
Enable the SBT plugin globally by adding Enable the SBT plugin globally by adding
```scala ```scala
addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M12") addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.0-M13")
``` ```
to `~/.sbt/0.13/plugins/build.sbt` to `~/.sbt/0.13/plugins/build.sbt`
@ -256,18 +256,6 @@ provide more output about what's going on than their default implementations do.
// TODO Change cache policy, sandboxing, parallel downloads, limitations // TODO Change cache policy, sandboxing, parallel downloads, limitations
``` ```
TEMPORARY As of the `1.0.0-M12` version, the SBT plugin doesn't re-use the `credentials` setting from SBT yet.
To enable credentials for a repository, add its credentials to `coursierCredentials`, like
```scala
resolvers += "corp-releases" at "http://nexus.corp.com/content/repositories/releases"
coursierCredentials += "corp-releases" -> coursier.Credentials("user", "pass")
// alternatively, read credentials from a file
coursierCredentials += "corp-releases" -> coursier.Credentials(file("path/to/credentials"))
```
Future versions of the plugin should support the `credentials` setting out-of-the-box.
### Command-line ### Command-line
Download and run its laucher with Download and run its laucher with
@ -409,7 +397,7 @@ The `bootstrap` generates tiny bootstrap launchers, able to pull their dependenc
repositories on first launch. For example, the launcher of coursier is [generated](https://github.com/alexarchambault/coursier/blob/master/project/generate-launcher.sh) with a command like repositories on first launch. For example, the launcher of coursier is [generated](https://github.com/alexarchambault/coursier/blob/master/project/generate-launcher.sh) with a command like
``` ```
$ ./coursier bootstrap \ $ ./coursier bootstrap \
io.get-coursier:coursier-cli_2.11:1.0.0-M12 \ io.get-coursier:coursier-cli_2.11:1.0.0-M13 \
-b -f -o coursier \ -b -f -o coursier \
-M coursier.cli.Coursier -M coursier.cli.Coursier
``` ```
@ -421,12 +409,12 @@ See `./coursier bootstrap --help` for a list of the available options.
Add to your `build.sbt` Add to your `build.sbt`
```scala ```scala
libraryDependencies ++= Seq( libraryDependencies ++= Seq(
"io.get-coursier" %% "coursier" % "1.0.0-M12", "io.get-coursier" %% "coursier" % "1.0.0-M13",
"io.get-coursier" %% "coursier-cache" % "1.0.0-M12" "io.get-coursier" %% "coursier-cache" % "1.0.0-M13"
) )
``` ```
The first module, `"io.get-coursier" %% "coursier" % "1.0.0-M12"`, mainly depends on The first module, `"io.get-coursier" %% "coursier" % "1.0.0-M13"`, mainly depends on
`scalaz-core` (and only it, *not* `scalaz-concurrent` for example). It contains among others, `scalaz-core` (and only it, *not* `scalaz-concurrent` for example). It contains among others,
definitions, definitions,
mainly in [`Definitions.scala`](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala), mainly in [`Definitions.scala`](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala),
@ -436,7 +424,7 @@ that expects to be given metadata, wrapped in any `Monad`, then feeds these to `
you the final `Resolution`, wrapped in the same `Monad` it was given input. This final `Resolution` has all the dependencies, you the final `Resolution`, wrapped in the same `Monad` it was given input. This final `Resolution` has all the dependencies,
including the transitive ones. including the transitive ones.
The second module, `"io.get-coursier" %% "coursier-cache" % "1.0.0-M12"`, is precisely in charge of fetching The second module, `"io.get-coursier" %% "coursier-cache" % "1.0.0-M13"`, is precisely in charge of fetching
these input metadata. It uses `scalaz.concurrent.Task` as a `Monad` to wrap them. It also fetches artifacts (JARs, etc.). these input metadata. It uses `scalaz.concurrent.Task` as a `Monad` to wrap them. It also fetches artifacts (JARs, etc.).
It caches all of these (metadata and artifacts) on disk, and validates checksums too. It caches all of these (metadata and artifacts) on disk, and validates checksums too.