branch: elpa/eldoc-mouse
commit 00b0b04f2f3a2f7667b9acdab4d52ee8124448c5
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Update README with eldoc-mouse usage instructions
Add instructions for using eldoc-mouse with key binding.
---
README.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/README.md b/README.md
index 19837e0afd..fdf278260e 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,10 @@ Or if you simply want to enable mouse hover to all buffers
where eldoc is availa
Or if you want to show document only when you press a key, and don't want to
enable mouse hover, then:
``` elisp
+(use-package eldoc :ensure t)
+(use-package eglot :ensure t)
+;; if you use the eglot, elodc package from elpa, the above two lines to
ensure them be loaded before
+;; load eldoc-mouse to avoid recursive load error.
(use-package eldoc-mouse :ensure t)
;; replace <f1> <f1> to a key you like. Displaying document on a popup when
you press a key.
(global-set-key (kbd "<f1> <f1>") 'eldoc-mouse-pop-doc-at-cursor)
