Skip to content
This repository was archived by the owner on Feb 20, 2019. It is now read-only.

Commit 5ee5ded

Browse files
committed
Adds instructions for building pickling and docs
1 parent ddf9c2c commit 5ee5ded

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,19 @@ Known limitations:
7676
3. Picklers are generated directly at call sites, since we cannot have introduceTopLevel in 2.10.x.
7777
4. No runtime compilation, since it's not obvious how to package it without inducing a dependency on `scala-compiler.jar`.
7878
-->
79+
80+
## Contributing
81+
82+
### Building
83+
84+
Scala/pickling uses sbt. So, just make sure you've got [sbt installed](http://www.scala-sbt.org/0.13/tutorial/Setup.html), `cd` into the root directory of pickling, and simply type `sbt` at the command line.
85+
86+
To build Scala/pickling, from the sbt prompt, just type `compile`.
87+
88+
To run the Scala/pickling test suite, from the sbt prompt, just type `test`.
89+
90+
If you want to add documentation, our overview-style docs are located in the `docs/` directory. We use [mkdocs](http://www.mkdocs.org/), a tool for taking hierarchies of documentation written in markdown, and generating a static set of docs. To install `mkdocs`, you need python and pip, the python package manager. Installation is one line, `pip install mkdocs`. _Note: if pip fails, try installing version 1.2.1 of pip by doing `sudo easy_install pip==1.2.1`)_.
91+
92+
To preview the docs on a local web server, just run `mkdocs serve` from the root directory of pickling and visit http://localhost:8000.
93+
94+
To generate a directory of the static HTML, just run `mkdocs build`. The static HTML will be located in `/site`.

0 commit comments

Comments
 (0)