[commit: haddock] ghc-7.6: Use markdown for html-test/README (a20efa0)

Repository : ssh://darcs.haskell.org//srv/darcs/haddock

On branch  : ghc-7.6

http://hackage.haskell.org/trac/ghc/changeset/a20efa02eef21b70c2cc3183217b55ce470b2826

>---------------------------------------------------------------

commit a20efa02eef21b70c2cc3183217b55ce470b2826
Author: Simon Hengel <[email protected]>
Date:   Thu Oct 18 08:48:02 2012 +0200

    Use markdown for html-test/README

>---------------------------------------------------------------

 html-test/{README => README.markdown} |   17 ++++++++++-------
 1 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/html-test/README b/html-test/README.markdown
similarity index 54%
rename from html-test/README
rename to html-test/README.markdown
index 082104b..8d57aca 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"'