aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuchen Pei <hi@ypei.me>2022-08-16 14:39:04 +1000
committerYuchen Pei <hi@ypei.me>2022-08-16 17:38:41 +1000
commit70816036a85e96ba07790b7c23d243c7ac1418fa (patch)
tree880201636249cb6ea5023761aaf632792c4e9a82
parent9d27e670d46b63d123167cf56340b57445c99618 (diff)
updating readme now that the org backend supports odir
-rw-r--r--README.org9
1 files changed, 4 insertions, 5 deletions
diff --git a/README.org b/README.org
index 17e352b3..72eb85e4 100644
--- a/README.org
+++ b/README.org
@@ -85,12 +85,10 @@ and run the commands:
#+begin_src sh
cd lens-5.1
cabal haddock --haddock-option=--org
-ls lens-5.1.org # If success, the org file should be placed here
+# If success, the org file should be placed under dist-newstyle
+ls ./dist-newstyle/build/*/*/lens-5.1/doc/html/lens/lens-5.1.org
#+end_src
-If success, a fresh new org documentation will be placed under the
-package directory (not in dist-newstyle!).
-
*** With Hadrian
In order to build documentation for GHC API or Haskell Hierarchical
@@ -135,7 +133,8 @@ cd ghc
# may arise
./boot && ./configure
hadrian/build docs -j --flavour=Quick
-ls *.org # If success, the org files should be placed here
+# If success, the org files should be placed under ./_build/doc/html/libraries/
+ls ./_build/doc/html/libraries/*/*.org
#+end_src
** Tips