branch: elpa/eldoc-mouse
commit 87467461d323d951dd3429420a467b4c62699f4d
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Update README with eldoc-mouse usage instructions
Added instructions for enabling eldoc-mouse functionality.
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index addc875920b..e901459483c 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,16 @@ Add the following in your Emacs configuration:
;; enable mouse hover for eglot managed buffers, and emacs lisp buffers. ;;
optional
:hook (eglot-managed-mode emacs-lisp-mode))
```
+Or if you simply want to enable mouse hover to all buffers where eldoc is
available as a minor mode
+
+``` elisp
+(use-package eldoc-mouse
+ ;; replace <f1> <f1> to a key you like, "C-h ." maybe. Displaying document
on a popup when you press a key.
+ :bind (:map eldoc-mouse-mode-map
+ ("<f1> <f1>" . eldoc-mouse-pop-doc-at-cursor)) ;; optional
+ :hook eldoc-mode)
+```
+
Or if you want to show document only when you press a key, and don't want to
enable mouse hover, then:
``` elisp
