[commit: haddock] master, wip/api-annot-tweaks-7.10, wip/api-annots-ghc-7.10-3: Turn the README into GitHub Markdown format. (9bd2bf9)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/haddock

On branches: master,wip/api-annot-tweaks-7.10,wip/api-annots-ghc-7.10-3
Link       : http://git.haskell.org/haddock.git/commitdiff/9bd2bf9e8cbf1b2cc2affd27096b79d149528c5b

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

commit 9bd2bf9e8cbf1b2cc2affd27096b79d149528c5b
Author: Njagi Mwaniki <mwanikibusiness at gmail.com>
Date:   Sat Dec 27 23:28:59 2014 +0300

    Turn the README into GitHub Markdown format.
    
    Closes #354


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

9bd2bf9e8cbf1b2cc2affd27096b79d149528c5b
 README => README.md       | 18 ++++++++++++++----
 doc/{README => README.md} | 13 ++++++-------
 2 files changed, 20 insertions(+), 11 deletions(-)

diff --git a/README b/README.md
similarity index 90%
rename from README
rename to README.md
index 53f84bf..b85d99b 100644
--- a/README
+++ b/README.md
@@ -1,5 +1,7 @@
-Haddock, a Haskell Documentation Tool
-=====================================
+# Haddock, a Haskell Documentation Tool
+
+
+#### About haddock
 
 This is Haddock, a tool for automatically generating documentation
 from annotated Haskell source code.  It is primary intended for
@@ -26,12 +28,20 @@ generated.  Abstract types and classes are handled correctly.  In
 fact, even without any documentation annotations, Haddock can generate
 useful documentation from your source code.
 
+
+#### Documentation formats
+
 Haddock can generate documentation in multiple formats; currently HTML
 is implemented, and there is partial support for generating LaTeX and
 Hoogle.
 
+
+#### Source code documentation
+
 Full documentation can be found in the doc/ subdirectory, in DocBook
 format.
 
-Please create issues when you have any problems and pull requests if
-you have some code.
\ No newline at end of file
+
+#### Contributing
+
+Please create issues when you have any problems and pull requests if you have some code.
diff --git a/doc/README b/doc/README.md
similarity index 84%
rename from doc/README
rename to doc/README.md
index 5bc038b..cf1fc31 100644
--- a/doc/README
+++ b/doc/README.md
@@ -1,5 +1,4 @@
-Haddock documentation
----------------------
+# Haddock documentation
 
 The documentation is in DocBook XML format.  You need some tools to
 process it: at least xsltproc, and the DocBook XML DTD and XSL
@@ -8,19 +7,19 @@ process the documentation on your system, and a Makefile to actually
 do the processing (so, on Windows, you'll need Cygwin or MSys in
 addition to the DocBook XML tools).  To build the HTML documentation:
 
-   $ autoconf
-   $ ./configure
-   $ make html
+    $ autoconf
+    $ ./configure
+    $ make html
 
 which leaves the HTML documentation in a haddock/ subdirectory.
 
 Printable documentation can also be produced, eg.:
 
-   $ make pdf
+    $ make pdf
 
 or
 
-   $ make ps
+    $ make ps
 
 Generating the printed formats requires more tools (fop or xmltex) and
 tends to be a bit harder.