diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -12,8 +12,12 @@ This project consists of three packages: wrapper around `haddock-api`'s `Documentation.Haddock.haddock` function. * `haddock-api`: contains the program logic of the `haddock` tool. - [The haddocks for the `Documentation.Haddock` module][Documentation.Haddock] - offer a good overview of the functionality. + [The haddocks for the `Documentation.Haddock` + module][Documentation.Haddock] offer a good overview of the + functionality. However, this distribution comes with a modified + version `haddorg-api` which adds an org backend. See + [haddock-api/README.org](haddock-api/README.org) for more + information. * `haddock-library`: is concerned with the parsing and processing of the Haddock markup language. Unlike the other packages, it is expected to build |