aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org28
1 files changed, 18 insertions, 10 deletions
diff --git a/README.org b/README.org
index f45ec2f..4ca30be 100644
--- a/README.org
+++ b/README.org
@@ -1,7 +1,7 @@
-#+title: Haskell Code Explorer
+#+title: hcel
-This is an updated version of [[https://github.com/alexwl/haskell-code-explorer][Haskell Code Explorer]], it works with
-GHC-9.2.2 with Cabal-3.6.2.0, and possibly other adjacent versions.
+hcel is a fork of [[https://github.com/alexwl/haskell-code-explorer][Haskell Code Explorer]], it works with GHC-9.2.2 with
+Cabal-3.6.2.0, and possibly other adjacent versions.
* Install
@@ -24,7 +24,8 @@ cabal build all
haskell-code-indexer -p .
#+end_src
-After this you can do
+After indexing the ./dist-newstyle directory is no longer by hcel and
+can be removed to save space. To launch the app, run
#+begin_src sh
haskell-code-server -p /path/to/package1 -p /path/to/package2 ...
@@ -32,9 +33,17 @@ haskell-code-server -p /path/to/package1 -p /path/to/package2 ...
and the app will be available at localhost:3000.
+You can also hook up a local hoogle for documentation lookup:
+
+#+begin_src sh
+hoogle server
+# configure a reverse proxy to hook it up with a domain say https://hoogle.localhost with self-signed cert, then run
+haskell-code-server -p /path/to/package1 -p /path/to/package2 --use-hoogle-api --hoogle-api https://hoogle.localhost/ --disable-hoogle-api-cert-check
+#+end_src
+
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.
+https://g.ypei.me/hcel.git/tree/README.md.original.
* Difference from the original version
@@ -48,10 +57,9 @@ about missing files.
The original haskell-code-explorer is written by Alexey Kiryushin
(alexey.a.kiryushin@gmail.com), hosted at [[https://github.com/alexwl/haskell-code-explorer][github]].
-The port to 9.2.2 is done by Yuchen Pei (id@ypei.org).
+This fork is maintained by Yuchen Pei (id@ypei.org).
The original work is under the [[https://www.gnu.org/licenses/license-list.html#Expat][expat license]], while the changes by
-Yuchen Pei are covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU AGPLv3+]] and you may find the license
-text in a file named COPYING.agpl3 in the project tree. As a
-combination, this work as a whole is licensed under [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU AGPLv3+]]
-([[https://www.gnu.org/licenses/gpl-faq.html#WhatDoesCompatMean][why?]]).
+Yuchen Pei are covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU AGPLv3+]]. You may find the license text
+in a file named COPYING.agpl3 in the project tree. As a combination,
+this work as a whole is covered by the terms of [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU AGPLv3+]] ([[https://www.gnu.org/licenses/gpl-faq.html#WhatDoesCompatMean][why?]]).