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

Add development tips section in README

This commit is contained in:
Alexandre Archambault 2016-02-24 20:22:28 +01:00
parent 06d0e4fac3
commit 03f6359cf7
2 changed files with 28 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -52,8 +52,9 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [
4. [Limitations](#limitations) 4. [Limitations](#limitations)
5. [FAQ](#faq) 5. [FAQ](#faq)
6. [Roadmap](#roadmap) 6. [Roadmap](#roadmap)
7. [Contributors](#contributors) 7. [Development tips](#development-tips)
8. [Projects using coursier](#projects-using-coursier) 8. [Contributors](#contributors)
9. [Projects using coursier](#projects-using-coursier)
## Quick start ## Quick start
@ -605,6 +606,17 @@ Set the `COURSIER_NO_TERM` environment variable to `1`. This disables the
progress bar message, and prints simple `Downloading URL` / `Downloaded URL` progress bar message, and prints simple `Downloading URL` / `Downloaded URL`
instead. instead.
## Development tips
#### Working on the plugin module in an IDE
Set `scalaVersion` to `2.10.6` in `build.sbt`. Then re-open / reload the coursier project.
#### Running the Scala JS tests
They require `npm install` to have been run once from the `coursier` directory or a subdirectory of
it. They can then be run with `sbt testsJS/test`.
## Roadmap ## Roadmap
The first releases were milestones like `0.1.0-M?`. As a launcher, basic Ivy The first releases were milestones like `0.1.0-M?`. As a launcher, basic Ivy

16
doc/README.md
View File

@ -52,8 +52,9 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [
4. [Limitations](#limitations) 4. [Limitations](#limitations)
5. [FAQ](#faq) 5. [FAQ](#faq)
6. [Roadmap](#roadmap) 6. [Roadmap](#roadmap)
7. [Contributors](#contributors) 7. [Development tips](#development-tips)
8. [Projects using coursier](#projects-using-coursier) 8. [Contributors](#contributors)
9. [Projects using coursier](#projects-using-coursier)
## Quick start ## Quick start
@ -629,6 +630,17 @@ Set the `COURSIER_NO_TERM` environment variable to `1`. This disables the
progress bar message, and prints simple `Downloading URL` / `Downloaded URL` progress bar message, and prints simple `Downloading URL` / `Downloaded URL`
instead. instead.
## Development tips
#### Working on the plugin module in an IDE
Set `scalaVersion` to `2.10.6` in `build.sbt`. Then re-open / reload the coursier project.
#### Running the Scala JS tests
They require `npm install` to have been run once from the `coursier` directory or a subdirectory of
it. They can then be run with `sbt testsJS/test`.
## Roadmap ## Roadmap
The first releases were milestones like `0.1.0-M?`. As a launcher, basic Ivy The first releases were milestones like `0.1.0-M?`. As a launcher, basic Ivy