aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2021-08-29 01:32:50 +0200
committerTeddy Wing2021-08-29 01:46:34 +0200
commit16e297f319d45f34bc5142236ab9f3e81109d4b6 (patch)
treecb66c4878d1356b39dec250a88a9fe91cd22c898
parentbd2e97716a98266907e61f85be662079ad75dd48 (diff)
downloadreadline-incdec-16e297f319d45f34bc5142236ab9f3e81109d4b6.tar.bz2
README: Complete the Install section
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index e1232b7..f12e880 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,14 @@ manually. By default:
## Install
-TODO
+Mac OS X users can install with Homebrew:
+
+ $ brew install teddywing/formulae/readline-incdec
+
+On other platforms, download the `incdec.bash` and, if desired,
+`incdec-bindings.bash` files.
+
+Then source the script in your Bash RC file:
source /path/to/incdec.bash
@@ -31,11 +38,13 @@ To enable the default bindings, also add:
source /path/to/incdec-bindings.bash
-
+Custom bindings can be added in place of the defaults. For example, this defines
+bindings for `C-x -` and `C-x +`:
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).