diff options
author | Chris Rebert <github@rebertia.com> | 2014-10-12 11:37:52 +0400 |
---|---|---|
committer | Chris Rebert <github@rebertia.com> | 2014-10-12 11:37:52 +0400 |
commit | ebe9caa78558c7a07a36a13494a005a9fb1e2ade (patch) | |
tree | 8e8d9bc718a98f0b6fc224f2d46cfe2519ff7de0 | |
parent | fb1aea5520723f422ce18cffd67075c1f7112aff (diff) |
add more to CONTRIBUTING.md
-rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e61073..ab3b05f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,2 +1,23 @@ +Hacking on Rorschach +================= +## How do I build Rorschach? +1. [Install sbt](http://www.scala-sbt.org/download.html) +2. Go to your `rorschach` directory. +3. Run `sbt compile` + +## How do I run the Rorschach service locally for test purposes? +**This method is not recommended for use in production deployments!** + +0. Ensure that sbt is installed (see above). +1. Go to your `rorschach` directory. +2. Run `sbt` +3. At the sbt prompt, enter `re-start 9090` (replace `9090` with whatever port you want the HTTP server to run on) or `re-start` (which will use the default port specified in `application.conf`). Note that running on ports <= 1024 requires root privileges (not recommended) or using port mapping. + +## 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 `rorschach` directory. +2. Run `sbt assembly` +3. If the build is successful, the desired JAR will be generated as `target/scala-2.10/rorschach-assembly-1.0.jar`. + ## Licensing Rorschach is licensed under The MIT License. By contributing to Rorschach, you agree to license your contribution under [The MIT License](https://github.com/twbs/rorschach/blob/master/LICENSE.txt). |