commit 32aaca5e6b88c777c4268499a94198e08b3f005e
parent 8284235929dc90557682f3c78cb27b1fda620737
Author: Lou Woell <lou.woell@posteo.de>
Date: Mon, 29 Sep 2025 16:25:28 +0200
README: expand on haredoc.el installation instructions
Diffstat:
| M | README.md | | | 30 | ++++++++++++++++++++++++++---- |
1 file changed, 26 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -72,8 +72,9 @@ let me know that you found this tool useful, you can reach me via
## Editor Integrations
### Emacs integration
-`haredoc.el` provides an emacs interface using harehelper. The main entry points
-are `haredoc/goto-definition`, `haredoc` and `haredoc/describe-thing-at-point`.
+`haredoc.el` provides an emacs interface to haredoc using harehelper. The main
+entry points are `haredoc/goto-definition`, `haredoc` and
+`haredoc/describe-thing-at-point`.
To enable the default keymap in hare-mode, add `haredoc-nav-mode` to your
`hare-mode-hook`.
@@ -96,14 +97,35 @@ Default keybindings in haredoc buffers:
- `d`: narrow haredoc to documentation of declaration at point
- `u`: show documentation for one namespace level up
-#### Installation with [elpaca](https://github.com/progfolio/elpaca)
+#### Installation
+
+The current version of the package assumes the `harehelper` executable to be
+located in the same directory as `haredoc.el`. You can change this assumption by
+modifying `haredoc-helperbin`.
+
+The following `use-package` declarations include a build step for harehelper.
+
+- with `package-vc`:
+
+```emacs-lisp
+(setq package-vc-allow-build-commands t)
+(use-package reader
+ :vc (:url "https://git.repetitions.de/harehelper"
+ :make "all")
+ :hook (hare-mode . haredoc-nav-mode)
+ :config
+ ;;...
+)
+```
+
+- with [elpaca](https://github.com/progfolio/elpaca):
```emacs-lisp
(use-package haredoc
:defer t
:ensure (haredoc
:type git
- :repo https://git.repetitions.de/harehelper
+ :repo "https://git.repetitions.de/harehelper"
:pre-build (("make"))
:files (:defaults "harehelper"))
:hook (hare-mode . haredoc-nav-mode)