diff options
| author | Yuchen Pei <hi@ypei.me> | 2022-07-18 15:40:47 +1000 |
|---|---|---|
| committer | Yuchen Pei <hi@ypei.me> | 2022-07-18 18:09:23 +1000 |
| commit | 131e3b41d6128d2e4b66be8582ae60ccd6380994 (patch) | |
| tree | 10216d902ae8bdd07d6bf40ebb3e1627fb3d7cdf /README.md | |
| parent | c8b9b18d5f5ce9816d3e06aa5f90665fcdfa83cb (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 |