diff options
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 29 |
1 files changed, 29 insertions, 0 deletions
@@ -119,6 +119,7 @@ you please, and copy the following data files to the same place: data/ s5/ slidy/ + slideous/ dzslides/ pcre-license.txt pcre3.dll @@ -130,3 +131,31 @@ This is essentially what the binary installer does. [blaze-html]: http://hackage.haskell.org/package/blaze-html [Cabal User's Guide]: http://www.haskell.org/cabal/release/latest/doc/users-guide/builders.html#setup-configure-paths + +Running tests +------------- + +Pandoc comes with an automated test suite integrated to cabal. +To enable the tests, compile pandoc with the `tests` flag: + + cabal install -ftests + +Note: If you obtained the source via git, you should first do + + git submodule update --init templates + +to populate the templates subdirectory. (You can skip this step +if you obtained the source from a release tarball.) + +To run the tests: + + cabal test + +If you add a new feature to pandoc, please add tests as well, following +the pattern of the existing tests. The test suite code is in +`src/test-pandoc.hs`. If you are adding a new reader or writer, it is +probably easiest to add some data files to the `tests` directory, and +modify `src/Tests/Old.hs`. Otherwise, it is better to modify the module +under the `src/Tests` hierarchy corresponding to the pandoc module you +are changing. + |