aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Hengel <sol@typeful.net>2012-10-18 08:48:02 +0200
committerSimon Hengel <sol@typeful.net>2012-10-18 08:50:26 +0200
commita20efa02eef21b70c2cc3183217b55ce470b2826 (patch)
tree2891c749ca77ef3c7a096916df53f25eda9a8dad
parentcbc8e789b8b6308144ebdaf866ec202fe608647d (diff)
Use markdown for html-test/README
-rw-r--r--html-test/README.markdown (renamed from html-test/README)17
1 files changed, 10 insertions, 7 deletions
diff --git a/html-test/README b/html-test/README.markdown
index 082104b0..8d57acab 100644
--- a/html-test/README
+++ b/html-test/README.markdown
@@ -3,22 +3,25 @@ is, it compares output files against a set of reference files.
To add a new test:
- 1) Create a module in the "html-test/src" directory.
+ 1. Create a module in the `html-test/src` directory.
- 2) Run "cabal test". You should now have "html-test/out/<modulename>.html".
+ 2. Run `cabal test`. You should now have `html-test/out/<modulename>.html`.
The test passes since there is no reference file to compare with.
- 3) To make a reference file from the output file, do
- runhaskell accept.lhs <modulename>
+ 3. To make a reference file from the output file, run
+
+ html-test/accept.lhs <modulename>
Tips and tricks:
To "accept" all output files (copy them to reference files), run
- runhaskell accept.lhs
+
+ runhaskell accept.lhs
You can run all tests despite failing tests, like so
- cabal test --test-option=all
+
+ cabal test --test-option=all
You can pass extra options to haddock like so
- cabal test --test-options='all --title="All Tests"'
+ cabal test --test-options='all --title="All Tests"'