aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2021-08-25 23:57:04 +0200
committerTeddy Wing2021-08-25 23:57:04 +0200
commit69d01de9d79fe08a9d03a2db659ce3b7615fcf88 (patch)
treebbd82f4d58f8ba6b57274415b85d77ec4e5499c2
parent443e4ef5bf354477c0629197dd2b3e7dcc9ecf2e (diff)
downloadreadline-incdec-69d01de9d79fe08a9d03a2db659ce3b7615fcf88.tar.bz2
README: Add ideas for demo explanation and install instructions
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index ed07b93..59431fd 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,10 @@ Readline bindings to increment and decrement numbers on the command line.
## Demo
+The commands increment or decrement the closest number to the left of point. If
+point is to the left of the first number in the line, the first number is
+modified.
+
TODO
@@ -12,9 +16,16 @@ TODO
TODO
source /path/to/incdec.bash
+
+To enable the default bindings, also add:
+
source /path/to/incdec-bindings.bash
+
+ bind -x '"\C-x-": __readline_incdec_decrement'
+ bind -x '"\C-x+": __readline_incdec_increment'
+
## License
Copyright © 2021 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).