Wed Jul 8 08:28:23 UTC 2015

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

On branches: 2.15,2.15.0.1,2.15.0.2,T6018-injective-type-families,adamse-D1033,clean,fix-travis,ghc-head,master,metainfo,v2.15,wip/10268,wip/10313,wip/D538,wip/D538-1,wip/D538-2,wip/D538-3,wip/D538-4,wip/D538-5,wip/D538-6,wip/D548-master,wip/D548-master-2,wip/T10483,wip/T8584,wip/T9840,wip/api-ann-hstylit,wip/api-ann-hstylit-1,wip/api-ann-hstylit-2,wip/api-ann-hstylit-3,wip/api-ann-hstylit-4,wip/api-ann-hstylit-5,wip/api-annot-tweaks-7.10,wip/api-annots-ghc-7.10-3,wip/ast-annotations-separate,wip/ast-prepare-annotations,wip/ast-prepare-annotations-final,wip/ast-prepare-annotations-final2,wip/ast-prepare-annotations-final3,wip/ast-prepare-annotations-final4,wip/ast-prepare-annotations-final5,wip/ast-prepare-annotations-final6,wip/attoparsec-update,wip/landmine-param-family,wip/orf-new,wip/orf-reboot,wip/pattern-synonyms,wip/rae,wip/remove-cabal-dep,wip/trac-9744
Link       : http://git.haskell.org/haddock.git/commitdiff/18a5d55f0c31fef9198ee8ed54f4f5fa8f609295

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

commit 18a5d55f0c31fef9198ee8ed54f4f5fa8f609295
Author: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>
Date:   Thu Jun 12 07:24:29 2014 +0200

    Slightly update the readme.
    
    Style-sheets are no longer a recent thing, dead links, old maintainers,
    different formats.


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

18a5d55f0c31fef9198ee8ed54f4f5fa8f609295
 README | 31 ++++++++++---------------------
 1 file changed, 10 insertions(+), 21 deletions(-)

diff --git a/README b/README
index 9f205d3..53f84bf 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 at gmail.com> or
-Simon Marlow <simonmar at 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

