diff options
| author | Chris Rebert <github@rebertia.com> | 2015-04-25 10:26:00 +0300 |
|---|---|---|
| committer | Chris Rebert <github@rebertia.com> | 2015-04-25 10:26:00 +0300 |
| commit | 50c0add03b166ee34143319d2334ae5a5a7a61fa (patch) | |
| tree | c0f2d496e5930e19cf04da0a6adf42fefb9be528 /CONTRIBUTING.md | |
| parent | 4594bdd37cd7fa9746eac91c3139dff1704f8f3b (diff) | |
Create CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..77d3469 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +Hacking on NO CARRIER +================= +## How do I build NO CARRIER? +1. [Install sbt](http://www.scala-sbt.org/download.html) +2. Go to your `no-carrier` directory. +3. Run `sbt compile` + +## How do I run NO CARRIER's unit test suite? +0. Ensure that sbt is installed (see above). +1. Go to your `no-carrier` directory. +2. Run `sbt test` + +## How do I generate a single self-sufficient JAR that includes all of the necessary dependencies? +0. Ensure that sbt is installed (see above). +1. Go to your `no-carrier` directory. +2. Run `sbt assembly` +3. If the build is successful, the desired JAR will be generated as `target/scala-2.11/no-carrier-assembly-1.0.jar`. + +## Licensing +NO CARRIER is licensed under The MIT License. By contributing to NO CARRIER, you agree to license your contribution under [The MIT License](https://github.com/cvrebert/no-carrier/blob/master/LICENSE.txt). |