diff options
| author | Yuchen Pei <hi@ypei.me> | 2022-07-18 21:18:46 +1000 |
|---|---|---|
| committer | Yuchen Pei <hi@ypei.me> | 2022-07-22 10:11:55 +1000 |
| commit | fd153b3abc563d3f13c96eddcf4aa6cf70b910dd (patch) | |
| tree | ccc52b0581e5c6fde23764df0cd450396b15baa2 /haddock-api/README.org | |
| parent | 71223881370782086aa1a55ee61a1327517fa39d (diff) | |
Updating README and adding a symlink to it
Diffstat (limited to 'haddock-api/README.org')
| -rw-r--r-- | haddock-api/README.org | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/haddock-api/README.org b/haddock-api/README.org index dff1df34..ac63165e 100644 --- a/haddock-api/README.org +++ b/haddock-api/README.org @@ -1,5 +1,8 @@ * haddorg-api +*NOTE*. This is the README file to ~haddorg-api~. For the README file +to haddock, see README.md. + ** Overview Haddock is a documentation generator for Haskell libraries and it @@ -80,7 +83,10 @@ package directory. ** Tips -- If you want +- If you would like cross-package links to work, simply concatenate + files. For example, concat the org file of base with that of any + library that say uses ~String~ in ~Prelude~ will cause ~String~ + links to navigate to the definition of ~String~. ** Coverage and areas for further work |