branch: elpa/eldoc-mouse
commit 12732fe67b73170dad3a913046aef34eed78e35a
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Update README with eldoc-mouse key binding instructions
Added instructions for using eldoc-mouse with key binding.
---
README.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/README.md b/README.md
index 37763b4b9ba..addc875920b 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,13 @@ 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 want to show document only when you press a key, and don't want to
enable mouse hover, then:
+
+``` elisp
+(use-package eldoc-mouse)
+;; 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)
+```
### Supported modes
* eglot-managed-mode
* emacs-lisp-mode
