[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/evil-args c19bc8d7f7 04/27: Updated README.
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/evil-args c19bc8d7f7 04/27: Updated README. |
Date: |
Wed, 2 Feb 2022 20:58:11 -0500 (EST) |
branch: elpa/evil-args
commit c19bc8d7f77bf76634a341eaf507e6e65c2c0247
Author: wcsmith <wconnorsmith@gmail.com>
Commit: wcsmith <wconnorsmith@gmail.com>
Updated README.
---
README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 85 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 1187157ba7..cbb7ff5bd8 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,90 @@
# evil-args
+Motions and text objects for delimited arguments in
[Evil](https://gitorious.org/evil/), the extensible vi layer for Emacs.
## Setup
Get it with:
- git clone https://github.com/wcsmith/evil-args.git
\ No newline at end of file
+ git clone https://github.com/wcsmith/evil-args.git
+
+Add the following to your `.emacs`:
+
+ (add-to-list 'load-path "path/to/evil-args")
+ (require 'evil-args)
+
+Optionally, add the following keybindings with keys of your choice:
+
+ (define-key evil-normal-state-map "L" 'evil-forward-arg)
+ (define-key evil-normal-state-map "H" 'evil-backward-arg)
+
+ (define-key evil-inner-text-objects-map "a" 'evil-inner-arg)
+ (define-key evil-outer-text-objects-map "a" 'evil-outer-arg)
+
+ (define-key evil-normal-state-map "K" 'evil-jump-out-args)
+
+##Functionality
+###`evil-forward-arg`/`evil-backward-arg`
+Move the curser to the next/previous argument.
+
+For example, successive presses of `evil-forward-arg` yield:
+
+ function(ar|g1, arg2, arg3)
+ function(arg1, |arg2, arg3)
+ function(arg1, arg2, |arg3)
+ function(arg1, arg2, arg3|)
+
+Successive presses of `evil-backward-arg` yield:
+
+ function(arg1, arg2, ar|g3)
+ function(arg1, arg2, |arg3)
+ function(arg1, |arg2, arg3)
+ function(|arg1, arg2, arg3)
+
+###`evil-inner-arg`/`evil-outer-arg`
+
+Select an inner/outer argument text object.
+
+For example, `cia` transforms:
+
+ function(ar|g1, arg2, arg3)
+ function(|, arg2, arg3)
+
+or
+
+ function(arg1, ar|g2, arg3)
+ function(arg1, |, arg3)
+
+`daa` transforms:
+
+ function(ar|g1, arg2, arg3)
+ function(|arg2, arg3)
+
+or
+
+ function(arg1, ar|g2, arg3)
+ function(arg1, |arg3)
+
+###`evil-jump-out-args`
+
+Moves to the beginning of the first object outside of the current argument
context.
+
+For example, pressing `evil-jump-out-args` yields:
+
+ function(arg1, arg2, ar|g3)
+ |function(arg1, arg2, arg3)
+
+Successive presses of `evil-jump-out-args` yield:
+
+ if (x == y) {
+ statement1;
+ state|ment2;
+ }
+
+ if (|x == y) {
+ statement1;
+ statement2;
+ }
+
+ |if (x == y) {
+ statement1;
+ statement2;
+ }
\ No newline at end of file
- [nongnu] elpa/evil-args 8d03d9d54a 07/27: Added license and boilerplate to evil-args.el., (continued)
- [nongnu] elpa/evil-args 8d03d9d54a 07/27: Added license and boilerplate to evil-args.el., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 46aab06c34 10/27: Added clearer language to keybinding documentation., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args e851ac4570 09/27: Added more commentary to evil-args.el., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args b2bfdab464 18/27: Declare interactive commands as evil-motions separately from their definitions., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args b4336c2317 20/27: Autoload text object macros as functions., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args b554f83a31 22/27: Merge pull request #3 from purcell/patch-1, ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 36ba8acc97 21/27: Add missing colon in Package-Requires header, ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 0ab683418c 17/27: Modified autoload structure for inclusion with MELPA., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 43c7fea7ee 19/27: Bugfix for evil-jump-out-args., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 1d3ae8b93e 16/27: Added text objects to autoload., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args c19bc8d7f7 04/27: Updated README.,
ELPA Syncer <=
- [nongnu] elpa/evil-args d172084a20 12/27: README formatting., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 1a0bb0e373 13/27: Added evil-args to evil customize group., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args f4cd3b8d5c 08/27: Added motion-state binding suggestions to README.md., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 2a88b4d199 23/27: Add melpa instructions to README, ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 574f9a24a1 02/27: Added LICENSE.txt., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 916f1bc81b 05/27: Enabled customization of openers/closers/delimiters., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 758ad5ae54 26/27: Honor count argument for text objects., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args c9c40dc094 15/27: Fixed autoload typo., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args 95deed7093 11/27: Added default bindings for text objects., ELPA Syncer, 2022/02/02
- [nongnu] elpa/evil-args b4c68bfb45 25/27: Merge pull request #8 from Emiller88/patch-1, ELPA Syncer, 2022/02/02