aboutsummaryrefslogtreecommitdiff
path: root/haddock-api
diff options
context:
space:
mode:
authorYuchen Pei <hi@ypei.me>2022-07-18 21:18:46 +1000
committerYuchen Pei <hi@ypei.me>2022-07-18 21:18:46 +1000
commitc1abd3467df5d3c4abeef5764b16df463d45e633 (patch)
treec2f17f7cba686c1635fb79df39be0279fa0c0146 /haddock-api
parente82c1e17bee52c3a022412d378675a327ffc42a4 (diff)
Updating README and adding a symlink to it
Diffstat (limited to 'haddock-api')
-rw-r--r--haddock-api/README.org8
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