branch: externals/frog-menu
commit 0d4d9f24a787e710782574bf0b5b59c254bcef99
Author: Clemens Radermacher <[email protected]>
Commit: Clemens Radermacher <[email protected]>
Update description for new frog-menu-type avy-side-window
---
README.org | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index 4693440..b64aa15 100644
--- a/README.org
+++ b/README.org
@@ -16,9 +16,12 @@ Inspired by
[[https://github.com/mrkkrp/ace-popup-menu][ace-popup-menu]].
* Example
To invoke the menu users can call =frog-menu-read=. How items are displayed
-and choosen depends on =frog-menu-type=. The default type =avy-posframe= uses
-[[https://github.com/abo-abo/avy][avy]] and
[[https://github.com/tumashu/posframe][posframe]]. Their handler functions can
be used as reference if you want
-to define a new =frog-menu-type=.
+and choosen depends on =frog-menu-type=. For graphical displays the type
+=avy-posframe= uses [[https://github.com/abo-abo/avy][avy]] and
[[https://github.com/tumashu/posframe][posframe]].
+
+In terminals the type =avy-side-window= is used. The default type handler
+functions can be used as reference if you want to define a new
+=frog-menu-type=.
Here is an example how you would invoke a frog menu:
@@ -27,8 +30,9 @@ Here is an example how you would invoke a frog menu:
'("a" "list" "of strings"))
#+end_src
-It is also possible to define additional action keys. Here is an example how
-you could use =frog-menu-read= to implement a
[[https://github.com/d12frosted/flyspell-correct][flyspell-correct-interface]]:
+It is also possible to define additional action keys (as shown in the
+screenshot). Here is an example how you could use =frog-menu-read= to
+implement a
[[https://github.com/d12frosted/flyspell-correct][flyspell-correct-interface]]:
#+begin_src elisp
(require 'flyspell-correct)
