branch: elpa/evil-numbers
commit 0934e38a769d1e25a18c0e8c42125fefdba62e34
Author: Campbell Barton <[email protected]>
Commit: Campbell Barton <[email protected]>
README: various minor updates
- Add myself as a contributor.
- Use capitals, full-stops.
- Capitalize VIM.
- Clarify that this works with the cursor before the numeric literal.
---
README.org | 30 ++++++++++++++++--------------
1 file changed, 16 insertions(+), 14 deletions(-)
diff --git a/README.org b/README.org
index 05ee55d422..cd0677432b 100644
--- a/README.org
+++ b/README.org
@@ -1,22 +1,23 @@
* Evil Numbers
- - Increment / Decrement binary, octal, decimal and hex literals
+ - Increment / Decrement binary, octal, decimal and hex literals.
- - works like C-a/C-x in vim, i.e. searches for number up to eol and then
- increments or decrements
-
- - Can keep zero padding up (off by default)
+ - Works like =C-a= / =C-x= in VIM, i.e. searches for number up to =eol= and
then
+ increments or decrements.
- When a region is active, as in evil's visual mode, all the
numbers within that region will be incremented/decremented (unlike
- in vim)
+ in VIM)
+
+ - Increment/decrement numbers incrementally like =g C-a= / =g C-x= in VIM.
+
+ - Optionally keep zero padding (off by default).
- - Increment/decrement numbers incrementally like g C-a/g C-x in vim.
** Detected Literals
- - binary, e.g. =0b0101=, =0B0101=
- - octal, e.g. =0o755=, =0O700=
- - hexadecimal, e.g. =0xDEADBEEF=, =0XCAFE=
- - unicode superscript and subscript, e.g. =²= and =₁=.
+ - Binary, e.g. =0b0101=, =0B0101=.
+ - Octal, e.g. =0o755=, =0O700=.
+ - Hexadecimal, e.g. =0xDEADBEEF=, =0XCAFE=.
+ - Unicode superscript and subscript, e.g. =²= and =₁=.
** Install
Put in =load-path=, =(require 'evil-numbers)= and bind, for example:
@@ -46,13 +47,13 @@
(define-key evil-normal-state-map (kbd "C-<kp-add>")
'evil-numbers/inc-at-pt-incremental)
(define-key evil-normal-state-map (kbd "C-<kp-subtract>")
'evil-numbers/dec-at-pt-incremental)
#+END_SRC
-
+
Set =evil-numbers/padDefault= to =t= if you want numbers to be padded with
zeros (numbers with a leading zero are always padded). If you want both
- behaviours, all commands take an optional argument =padded=.
+ behaviors, all commands take an optional argument =padded=.
** Usage
- Position cursor on literal and play with your numbers!
+ Position cursor over or before the literal and play with your numbers!
** Known Bugs
See http://github.com/juliapath/evil-numbers/issues
@@ -61,3 +62,4 @@
- Matthew Fidler <[email protected]>
- Michael Markert <[email protected]>
- Julia Path <[email protected]>
+ - Campbell Barton <[email protected]>
