X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/57560f2651584873760f4034259935c3a568f1c6..4e171a5b7e29031a2d40db14f05e7a945d8b08a5:/packages/eldoc-eval/README.md

diff --git a/packages/eldoc-eval/README.md b/packages/eldoc-eval/README.md
index e69de29bb..d29090240 100644
--- a/packages/eldoc-eval/README.md
+++ b/packages/eldoc-eval/README.md
@@ -0,0 +1,42 @@
+Enable eldoc support when minibuffer is in use.
+
+# Commentary:
+
+This package enables eldoc support when minibuffer is in use.
+
+Eldoc info is shown by default in mode-line,
+but you can have eldoc info somewhere else by setting
+`eldoc-in-minibuffer-show-fn` to another function (e.g `tooltip-show`).
+
+By default with this package `M-:` will use `pp-eval-expression`
+instead of `eval-expression`; you can change that by setting
+`eval-preferred-function` to something else.
+
+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)
+```
+
+Users of own minibuffer frame will have to set
+`eldoc-in-minibuffer-own-frame-p` to non-nil.
+
+You can turn On/Off eldoc support in minibuffer at any time
+with `eldoc-in-minibuffer-mode`.
+
+# Install:
+
+Add to .emacs:
+
+```lisp
+   (autoload 'eldoc-in-minibuffer-mode "eldoc-eval")
+   (eldoc-in-minibuffer-mode 1)
+```