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 /README | |
| parent | 43d0789910061eda305141ca19c35e51d3888188 (diff) | |
Turn the README into GitHub Markdown format.
Closes #354
Diffstat (limited to 'README')
| -rw-r--r-- | README | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/README b/README deleted file mode 100644 index 53f84bf0..00000000 --- a/README +++ /dev/null @@ -1,37 +0,0 @@ -Haddock, a Haskell Documentation Tool -===================================== - -This is Haddock, a tool for automatically generating documentation -from annotated Haskell source code. It is primary intended for -documenting library interfaces, but it should be useful for any kind -of Haskell code. - -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 -exposed in the generated documentation. For example, it is common to -implement a library in several modules, but define the external API by -having a single module which re-exports parts of these implementation -modules. Using Haddock, you can still write documentation annotations -next to the actual definitions of the functions and types in the -library, but the documentation annotations from the implementation -will be propagated to the external API when the documentation is -generated. Abstract types and classes are handled correctly. In -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 LaTeX and -Hoogle. - -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 |