diff options
| author | Yuchen Pei <hi@ypei.me> | 2022-07-18 15:40:47 +1000 |
|---|---|---|
| committer | Yuchen Pei <hi@ypei.me> | 2022-07-22 23:59:16 +1000 |
| commit | f257cd398c09b7d26f66f12123630f828c53202e (patch) | |
| tree | b1d4be52d6d4a19377957097bff60df0ce917d75 /README.md | |
| parent | d9ce45a947e39d83d17e479a8a36627150095a21 (diff) | |
Preparing for publication.
- license
- cabal
- readme
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 |