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:39 +01:00
parent f84b6c92a3
commit 2a385a60c7
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -65,7 +65,7 @@ From the API, these are specified manually - you are encouraged to use those too
Enable the SBT plugin by adding Enable the SBT plugin by adding
```scala ```scala
addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M2") addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M3")
``` ```
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.
@ -102,8 +102,8 @@ Fetching artifacts
Add to your `build.sbt` Add to your `build.sbt`
```scala ```scala
libraryDependencies ++= Seq( libraryDependencies ++= Seq(
"com.github.alexarchambault" %% "coursier" % "1.0.0-M2", "com.github.alexarchambault" %% "coursier" % "1.0.0-M3",
"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M2" "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M3"
) )
``` ```
@ -191,7 +191,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("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M2") addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M3")
``` ```
to `~/.sbt/0.13/plugins/build.sbt` to `~/.sbt/0.13/plugins/build.sbt`
@ -329,7 +329,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 \
com.github.alexarchambault:coursier-cli_2.11:1.0.0-M2 \ com.github.alexarchambault:coursier-cli_2.11:1.0.0-M3 \
-b -f -o coursier \ -b -f -o coursier \
-M coursier.cli.Coursier -M coursier.cli.Coursier
``` ```
@ -341,12 +341,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(
"com.github.alexarchambault" %% "coursier" % "1.0.0-M2", "com.github.alexarchambault" %% "coursier" % "1.0.0-M3",
"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M2" "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M3"
) )
``` ```
The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M2"`, mainly depends on The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M3"`, 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),
@ -356,7 +356,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, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M2"`, is precisely in charge of fetching The second module, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M3"`, 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.

18
doc/README.md
View File

@ -65,7 +65,7 @@ From the API, these are specified manually - you are encouraged to use those too
Enable the SBT plugin by adding Enable the SBT plugin by adding
```scala ```scala
addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M2") addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M3")
``` ```
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.
@ -102,8 +102,8 @@ Fetching artifacts
Add to your `build.sbt` Add to your `build.sbt`
```scala ```scala
libraryDependencies ++= Seq( libraryDependencies ++= Seq(
"com.github.alexarchambault" %% "coursier" % "1.0.0-M2", "com.github.alexarchambault" %% "coursier" % "1.0.0-M3",
"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M2" "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M3"
) )
``` ```
@ -191,7 +191,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("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M2") addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M3")
``` ```
to `~/.sbt/0.13/plugins/build.sbt` to `~/.sbt/0.13/plugins/build.sbt`
@ -331,7 +331,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 \
com.github.alexarchambault:coursier-cli_2.11:1.0.0-M2 \ com.github.alexarchambault:coursier-cli_2.11:1.0.0-M3 \
-b -f -o coursier \ -b -f -o coursier \
-M coursier.cli.Coursier -M coursier.cli.Coursier
``` ```
@ -343,12 +343,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(
"com.github.alexarchambault" %% "coursier" % "1.0.0-M2", "com.github.alexarchambault" %% "coursier" % "1.0.0-M3",
"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M2" "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M3"
) )
``` ```
The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M2"`, mainly depends on The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M3"`, 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),
@ -358,7 +358,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, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M2"`, is precisely in charge of fetching The second module, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M3"`, 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.