[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/eldoc-eval 9ce3ca7d2c 12/28: * README.md: Update.
From: |
Stefan Monnier |
Subject: |
[elpa] externals/eldoc-eval 9ce3ca7d2c 12/28: * README.md: Update. |
Date: |
Thu, 6 Jan 2022 08:34:55 -0500 (EST) |
branch: externals/eldoc-eval
commit 9ce3ca7d2cf3bb51db72bff3487b258f681a8430
Author: Thierry Volpiatto <thierry.volpiatto@gmail.com>
Commit: Thierry Volpiatto <thierry.volpiatto@gmail.com>
* README.md: Update.
---
README.md | 36 ++++++++++++++++++++++--------------
1 file changed, 22 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index d29090240a..e523626b9a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
+Eldoc-eval
+==========
+
+You can [![Support via
Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.1.3/dist/gratipay.png)](https://gratipay.com/thierryvolpiatto)
or
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=thierry.volpiatto@gmail.com&lc=US¤cy_code=EUR&bn=PP-DonationsBF:btn_donateCC_LG.gif:NonHosted)
to help this project.
+
+## Description
Enable eldoc support when minibuffer is in use.
# Commentary:
@@ -16,15 +22,15 @@ It also provides a convenient macro to enable eldoc support
in your own functions using minibuffer or in your defadvices,
that is `with-eldoc-in-minibuffer`, e.g:
-```lisp
-(defadvice edebug-eval-expression (around with-eldoc activate)
- "This advice enable eldoc support."
- (interactive (list (with-eldoc-in-minibuffer
- (read-from-minibuffer
- "Eval: " nil read-expression-map t
- 'read-expression-history))))
- ad-do-it)
-```
+
+ defadvice edebug-eval-expression (around with-eldoc activate)
+ "This advice enable eldoc support."
+ (interactive (list (with-eldoc-in-minibuffer
+ (read-from-minibuffer
+ "Eval: " nil read-expression-map t
+ 'read-expression-history))))
+ ad-do-it)
+
Users of own minibuffer frame will have to set
`eldoc-in-minibuffer-own-frame-p` to non-nil.
@@ -34,9 +40,11 @@ with `eldoc-in-minibuffer-mode`.
# Install:
-Add to .emacs:
+Add to your init file:
+
+If installed from git, add eldoc-eval.el to `load-path` and
+
+ (autoload 'eldoc-in-minibuffer-mode "eldoc-eval")
+ (eldoc-in-minibuffer-mode 1)
-```lisp
- (autoload 'eldoc-in-minibuffer-mode "eldoc-eval")
- (eldoc-in-minibuffer-mode 1)
-```
+Otherwise only `(eldoc-in-minibuffer-mode 1)` is needed.
- [elpa] externals/eldoc-eval 4924bfb1cc 02/28: * eldoc-eval.el (eldoc-in-minibuffer-mode): remove/add-hook `eval-expression-minibuffer-setup-hook'., (continued)
- [elpa] externals/eldoc-eval 4924bfb1cc 02/28: * eldoc-eval.el (eldoc-in-minibuffer-mode): remove/add-hook `eval-expression-minibuffer-setup-hook'., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval af5d4ddfe6 03/28: * eldoc-eval.el: Issue #2 Remap eval-expression., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval a0d5c41505 07/28: * eldoc-eval.el: Fix redisplay of mode-line in emacs-24.4., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval cf49d3324e 06/28: * eldoc-eval.el: Remove rolling function., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval f59a1ae7ec 16/28: Merge pull request #4 from wyuenho/patch-1, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval df03315658 15/28: Give group to eldoc-in-minibuffer-mode, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval cc37666378 11/28: Make timer not accessible within body., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 17946951b9 18/28: Merge pull request #5 from mix-yasuno/remove-warnings, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 4a1cf92dc5 22/28: Merge pull request #6 from lattfein/move-definition, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval a67fe36373 24/28: Merge branch 'master' of github.com:thierryvolpiatto/eldoc-eval, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 9ce3ca7d2c 12/28: * README.md: Update.,
Stefan Monnier <=
- [elpa] externals/eldoc-eval 6710179584 08/28: * eldoc-eval.el: Use lexical-binding., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval e0e6ea1af0 17/28: Remove warnings from byte compilation, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 7903b1e863 01/28: * eldoc-eval.el: Merge Stefan changes on ELPA., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval e646f28a88 21/28: Move eldoc-in-minibuffer-mode-map definition, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 6514b3377f 20/28: Silence the warning, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 475d68155b 23/28: Remove :version no more needed, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 99a055e2de 19/28: Move the minor mode definition, Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval e2d9805592 05/28: * eldoc-eval.el (eldoc-mode-line-stop-rolling-on-input): New user var., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval e87b89f89a 14/28: Update readme., Stefan Monnier, 2022/01/06
- [elpa] externals/eldoc-eval 9e7a1660f5 09/28: * eldoc-eval.el: Fix, eldoc-post-insert-mode doesn't exists anymore., Stefan Monnier, 2022/01/06