aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>2014-06-12 07:24:29 +0200
committerMateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>2014-06-12 07:24:29 +0200
commit18a5d55f0c31fef9198ee8ed54f4f5fa8f609295 (patch)
tree66c11b460e397f1aaba2a65f3d970cc305bd5f2e /README
parent276f201de589999690e49491089c7e7ec9cfbf3f (diff)
Slightly update the readme.
Style-sheets are no longer a recent thing, dead links, old maintainers, different formats.
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 10 insertions, 21 deletions
diff --git a/README b/README
index 9f205d3b..53f84bf0 100644
--- a/README
+++ b/README
@@ -6,13 +6,12 @@ from annotated Haskell source code. It is primary intended for
documenting library interfaces, but it should be useful for any kind
of Haskell code.
-Like other systems ([1],[2]), Haddock lets you write documentation
-annotations next to the definitions of functions and types in the
-source code, in a syntax that is easy on the eye when writing the
-source code (no heavyweight mark-up). The documentation generated by
-Haddock is fully hyperlinked - click on a type name in a type
-signature to go straight to the definition, and documentation, for
-that type.
+Haddock lets you write documentation annotations next to the
+definitions of functions and types in the source code, in a syntax
+that is easy on the eye when writing the source code (no heavyweight
+mark-up). The documentation generated by Haddock is fully hyperlinked
+- click on a type name in a type signature to go straight to the
+definition, and documentation, for that type.
Haddock understands Haskell's module system, so you can structure your
code however you like without worrying that internal structure will be
@@ -28,21 +27,11 @@ fact, even without any documentation annotations, Haddock can generate
useful documentation from your source code.
Haddock can generate documentation in multiple formats; currently HTML
-is implemented, and there is partial support for generating DocBook.
-The generated HTML uses stylesheets, so you need a fairly up-to-date
-browser to view it properly (Mozilla, Konqueror, Opera, and IE 6
-should all be ok).
+is implemented, and there is partial support for generating LaTeX and
+Hoogle.
Full documentation can be found in the doc/ subdirectory, in DocBook
format.
-Please send questions and suggestions to:
-
-David Waern <david.waern@gmail.com> or
-Simon Marlow <simonmar@microsoft.com>
-
-
-[1] IDoc - A No Frills Haskell Interface Documentation System
- http://www.cse.unsw.edu.au/~chak/haskell/idoc/
-
-[2] HDoc http://www.fmi.uni-passau.de/~groessli/hdoc/
+Please create issues when you have any problems and pull requests if
+you have some code. \ No newline at end of file