diff options
| author | Njagi Mwaniki <mwanikibusiness@gmail.com> | 2014-12-27 23:28:59 +0300 |
|---|---|---|
| committer | Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk> | 2014-12-29 15:30:44 +0000 |
| commit | 9bd2bf9e8cbf1b2cc2affd27096b79d149528c5b (patch) | |
| tree | 43a9f9d5380eb5efcf5a51c032c846da293abe71 | |
| parent | 43d0789910061eda305141ca19c35e51d3888188 (diff) | |
Turn the README into GitHub Markdown format.
Closes #354
| -rw-r--r-- | README.md (renamed from README) | 18 | ||||
| -rw-r--r-- | doc/README.md (renamed from doc/README) | 13 |
2 files changed, 20 insertions, 11 deletions
@@ -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 index 5bc038bf..cf1fc31b 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. |