aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.org b/README.org
index c78046b..f45ec2f 100644
--- a/README.org
+++ b/README.org
@@ -20,20 +20,28 @@ example:
cabal unpack sqlite-simple
cd sqlite-simple-x.y.z.w
cabal configure --enable-testsuites --enable-benchmarks
-cabal build
+cabal build all
haskell-code-indexer -p .
#+end_src
After this you can do
#+begin_src sh
-haskell-code-server -p /path/to/package1 -p /path/to/packag2 ...
+haskell-code-server -p /path/to/package1 -p /path/to/package2 ...
#+end_src
and the app will be available at localhost:3000.
-For the readme of the original version, see README.md, also available
-at https://g.ypei.me/haskell-code-explorer.git/tree/README.md.
+For the readme of the original version, see README.md.original in the
+project tree, also available at
+https://g.ypei.me/haskell-code-explorer.git/tree/README.md.original.
+
+* Difference from the original version
+
+The indexer of this version looks for all build targets, including
+testsuites and benchmarks, in the .cabal file, therefore you'll need
+to build them all before indexing, otherwise the indexer will complain
+about missing files.
* Contact and Copyright