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 /doc/README | |
| parent | 43d0789910061eda305141ca19c35e51d3888188 (diff) | |
Turn the README into GitHub Markdown format.
Closes #354
Diffstat (limited to 'doc/README')
| -rw-r--r-- | doc/README | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/doc/README b/doc/README deleted file mode 100644 index 5bc038bf..00000000 --- a/doc/README +++ /dev/null @@ -1,26 +0,0 @@ -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 -stylesheets. There's a configure script to detect the right way to -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 - -which leaves the HTML documentation in a haddock/ subdirectory. - -Printable documentation can also be produced, eg.: - - $ make pdf - -or - - $ make ps - -Generating the printed formats requires more tools (fop or xmltex) and -tends to be a bit harder. |