commit e74e6797195b5bb9d9bee98228f777f5ed1f814a
parent fb22df0ab54949f53114cf3d34a92945f5acee82
Author: Lou Woell <lou.woell@posteo.de>
Date: Tue, 9 Sep 2025 11:08:42 +0200
Update README
Diffstat:
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -3,9 +3,14 @@ A small tool for basic harelang interaction in Editors.
Harehelper is a small cli providing functionality needed to easily access hare
documentation from within an editor, and jump to definitions.
+In principle, everything needed for basic completion should be in place, I
+haven't attempted using harehelper for that yet though.
+
**VERY Work-in-Progress**
-all command name may change.
+- There's a bunch of stuff hardcoded that probably shouldn't be. (e.g. the base
+ value of HAREPATH and the linux tagset)
+- All command names may change.
## Functionality
@@ -54,3 +59,17 @@ $ harehelper list <module>
`haredoc.el` provides an emacs interface using harehelper. The main entry points
are `haredoc/goto-definition`, `haredoc` and `haredoc/describe-thing-at-point`.
+
+#### Installation with [elpaca](https://github.com/progfolio/elpaca)
+```emacs-lisp
+(use-package haredoc
+ :defer t
+ :ensure (haredoc
+ :type git
+ :repo https://git.repetitions.de/harehelper
+ :pre-build (("make"))
+ :files (:defaults "harehelper"))
+ :config
+ ;; ...
+)
+```