From c1abd3467df5d3c4abeef5764b16df463d45e633 Mon Sep 17 00:00:00 2001 From: Yuchen Pei Date: Mon, 18 Jul 2022 21:18:46 +1000 Subject: Updating README and adding a symlink to it --- README.org | 1 + haddock-api/README.org | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 120000 README.org diff --git a/README.org b/README.org new file mode 120000 index 00000000..2aeba2ae --- /dev/null +++ b/README.org @@ -0,0 +1 @@ +/home/hack/source/haddock/haddock-api/README.org \ No newline at end of file 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 -- cgit v1.2.3