aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuchen Pei <hi@ypei.me>2022-07-18 21:06:46 +1000
committerYuchen Pei <hi@ypei.me>2022-07-22 10:11:55 +1000
commit71223881370782086aa1a55ee61a1327517fa39d (patch)
tree08b414616e3d83f83c7dc767c540ccda0e43cf8f
parent473957d69a42fa1770a821bb6d17520a9305b213 (diff)
updated README with real links
-rw-r--r--haddock-api/README.org17
-rw-r--r--haddock-api/haddorg-api.cabal2
2 files changed, 10 insertions, 9 deletions
diff --git a/haddock-api/README.org b/haddock-api/README.org
index 4a00483c..dff1df34 100644
--- a/haddock-api/README.org
+++ b/haddock-api/README.org
@@ -11,15 +11,16 @@ invoke haddock to generate org files, of the Org Mode.
** Examples
-- base-4.16.1.org
-- ghc-lib-parser.org, pretending to be ghc (fake ghc)
+- [[https://ypei.org/assets/haddorg-output/base-4.16.1.0.org.gz][base-4.16.1.0.org]]
+- [[https://ypei.org/assets/haddorg-output/ghc-lib-parser-9.2.2.20220307.org.gz][ghc-lib-parser-9.2.2.20220307.org]], which can be used as a fake ghc
+ for cross-package linking
- lens
-- haddorg-api-2.26.1.org, also in this repository
-- haddock-library-2.26.1.org
-- haddorg-api + haddock-library + fake ghc + base, to demo
- cross-package links
-- fsd + sqlite-simple + debian, to demo cross-package links
-- and more...
+- [[https://ypei.org/assets/haddorg-output/haddorg-api-2.26.1.org.gz][haddorg-api-2.26.1.org]], also in this repository
+- [[https://ypei.org/assets/haddorg-output/haddock-library-2.26.1.org.gz][haddock-library-2.26.1.org]]
+- [[https://ypei.org/assets/haddorg-output/haddorg-ghc-base.org.gz][haddorg-api + haddock-library + fake ghc + base]], demonstrating
+ cross-package linking
+- [[https://ypei.org/assets/haddorg-output/fsd-sqlite-simple-debian.org.gz][fsd + sqlite-simple + debian]], to demonstrating cross-package linking
+- and [[https://ypei.org/assets/haddorg-output/][more...]]
** Install
diff --git a/haddock-api/haddorg-api.cabal b/haddock-api/haddorg-api.cabal
index e90d94a7..2dc30b35 100644
--- a/haddock-api/haddorg-api.cabal
+++ b/haddock-api/haddorg-api.cabal
@@ -2,7 +2,7 @@ cabal-version: 2.2
name: haddorg-api
version: 2.26.1
synopsis: haddock-api with an org backend
-description: This is haddorg-api. It is a modified version of the Haddock API (haddock-api) with the addition of an Org Backend.
+description: This is haddorg-api. It is a modified version of the Haddock API (haddock-api) with the addition of an Org Backend. See README.org for further information.
license: BSD-2-Clause AND AGPL-3.0-or-later
license-files: COPYING.freebsd, COPYING.agpl3
author: Haddock authors and Yuchen Pei