Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Added info on Stack to CONTRIBUTING.md.

Browse source
This commit is contained in:
John MacFarlane 2016-02-05 16:58:29 -08:00
parent 7358b473fd
commit c0515e09d4
1 changed files with 24 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
CONTRIBUTING.md
View file

@ -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