diff options
| author | Yuchen Pei <hi@ypei.me> | 2022-07-18 21:18:46 +1000 |
|---|---|---|
| committer | Yuchen Pei <hi@ypei.me> | 2022-07-22 23:59:20 +1000 |
| commit | 2ca51c8c06134897d53e7f1fbc3619edb2e1869c (patch) | |
| tree | 42aed2935121f22c797a46f7c71d9107777b9c63 /haddock-api | |
| parent | 0c506baf2c263f1060d587d30257c8e3e08f4b3b (diff) | |
Updating README and adding a symlink to it
Diffstat (limited to 'haddock-api')
| -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 |