aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuchen Pei <hi@ypei.me>2022-09-05 15:48:49 +1000
committerYuchen Pei <hi@ypei.me>2022-09-05 15:48:49 +1000
commit764262f85b96646cf276c29e230c7ae4914d2e71 (patch)
tree237e93b8cdf871611b0ae056a982005b959a1561
parent21075f62501ecf18d7e56cbe2212ba02bea141db (diff)
updating docs section on emacs
-rw-r--r--README.org7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.org b/README.org
index 992f55d..5d6b3f7 100644
--- a/README.org
+++ b/README.org
@@ -62,19 +62,20 @@ You may find an emacs client under the ~lisp~ directory. It covers
- Find references (based on compilation mode)
- Search identifiers in a package or globally (based on compilation mode)
- Highlight the identifier at point
-- Browse packages, modules and identifiers in an outline mode
+- Browse packages, modules and identifiers in an outline mode buffer
- Eldoc integration, showing type and documentation of the identifier
at point, or the selected expression.
- Syntax highlight (requires haskell-mode)
-To use, start a server, and set the endpoint:
+To start, start a server, and set the endpoint:
#+begin_src elisp
(require 'hc)
(setq hcel-endpoint "localhost:8080")
#+end_src
-To start, run command ~hcel~ to enter the outline mode.
+Then run command ~hcel~ to browse in a hcel-outline mode buffer, or
+~hcel-package~ to select a package and module in the minibuffer.
* Contact and Copyright