summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2016-02-05 16:58:29 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2016-02-05 16:58:29 -0800
commitc0515e09d47dffb7f345ea9bfde6a20a5b885d2d (patch)
tree4a456d38bd529d57ee421032467743bafb7a6e2f /CONTRIBUTING.md
parent7358b473fd7e83a0351542bc8a82b0cfc25db5ff (diff)
Added info on Stack to CONTRIBUTING.md.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md28
1 files changed, 24 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a9e1e6deb..f39acab10 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -150,17 +150,35 @@ Tests can be run as follows:
cabal build
cabal test
+or, if you're using [stack],
+
+ stack init
+ stack test
+
The test program is `tests/test-pandoc.hs`.
-Benchmarks can be enabled by passing the `--enable-benchmarks` flag
-to `cabal configure`, and run using `cabal bench`.
+Benchmarks
+----------
+
+To run benchmarks with cabal:
+
+ cabal configure --enable-benchmarks
+ cabal build
+ cabal bench
+
+With stack:
+
+ stack bench
Using the REPL
--------------
With a recent version of cabal, you can do `cabal repl` and get
-a ghci REPL for working with pandoc. We recommend using the following
-`.ghci` file (which can be placed in the source directory):
+a ghci REPL for working with pandoc. With [stack], use
+`cabal ghci`.
+
+We recommend using the following `.ghci` file (which can be
+placed in the source directory):
```
:set -fobject-code
@@ -267,3 +285,5 @@ The library is structured as follows:
[inprogress]: https://github.com/jgm/pandoc/labels/inprogress
[more discussion needed]: https://github.com/jgm/pandoc/labels/More%20discussion%20needed
[more info needed]: https://github.com/jgm/pandoc/labels/More%20info%20needed
+[stack]: https://github.com/commercialhaskell/stack
+