branch: elpa/evil-nerd-commenter
commit 41910491e742b8b50f8620814d9641ea23504852
Author: Chen Bin <[email protected]>
Commit: Chen Bin <[email protected]>
updated README
---
README.org | 61 +++++++++++++++++++++++++++++--------------------------------
1 file changed, 29 insertions(+), 32 deletions(-)
diff --git a/README.org b/README.org
index 633a9b12bd..c65f197443 100644
--- a/README.org
+++ b/README.org
@@ -1,14 +1,12 @@
* evil-nerd-commenter (v1.5.8)
-*This program could be used independently WITHOUT evil-mode!*
+*This program can be used independently WITHOUT
[[http://www.emacswiki.org/Evil][Evil]]!*
-It's [[http://www.vim.org/scripts/script.php?script_id=1218][Nerd Commenter]]
simulator which help you comment lines efficiently.
+A [[http://www.vim.org/scripts/script.php?script_id=1218][Nerd Commenter]]
emulation, help you comment code efficiently. For example, you can press key
`,,99j` or `99,ci` to comment out 99 lines.
-Other utilities are added to make it better than the original VIM plugin. For
example, you can copy and comment lines in one step
+I recommend you using it with Evil though it's optional.
-I recommend you using it with [[http://gitorious.org/evil][evil]] though evil
is optional.
-
-Evil is a Vim simulator which makes text manipulation efficient. For example,
you can press key `,,99j` or `99,ci` to comment out 99 lines.
+Tested on Emacs 23.4, 24.3, 24.4
* Why evil-nerd-commenter is better?
** A simple use case on the efficiency
@@ -31,16 +29,14 @@ evil-nerd-commenter is already uploaded to
[[http://melpa.milkbox.net/]]. The be
* Set up
** The easy way (RECOMMENDED)
-Nothing to set up.
-
-You may add one line of emacs lisp code into ~/.emacs to use default hot keys,
+You need add one liner into ~/.emacs to use default hotkeys,
#+BEGIN_SRC lisp
(evilnc-default-hotkeys)
#+END_SRC
-*That's all you need to know* unless you want to modify default key bindings!
+*That's all* unless you want to modify default key bindings!
-The content of evilnc-default-hotkeys is:
+The definition of evilnc-default-hotkeys:
#+BEGIN_SRC lisp
(defun evilnc-default-hotkeys ()
"Set the hotkeys of evil-nerd-comment"
@@ -58,14 +54,14 @@ The content of evilnc-default-hotkeys is:
))
#+END_SRC
-As you can see, the default hot key for commenting lines is "M-;", if you
don't use [[http://emacswiki.org/emacs/Evil][evil-mode]].
+As you can see, the default hotkey for commenting lines is "M-;", if you don't
use evil.
-You can mark at any column of the first line, scroll down, and comment *all
the lines* instead of selected region by "M-;".
+You can set mark at any column of the first line, scroll down, and comment
*all the lines* by pressing "M-;".
-You can copy the content of evilnc-default-hotkeys into .emacs instead of
calling it directly, if you don't like the default key binding.
+You can insert the content of evilnc-default-hotkeys into .emacs instead of
calling it directly.
** The hard way
-If you don't use emacs package manager please insert below code into your
~/.emacs:
+If you don't use package manager please insert below code into your ~/.emacs:
#+BEGIN_SRC lisp
;; I suppose you know how to install evil.
;; If NOT, check http://www.emacswiki.org/emacs/Evil
@@ -81,7 +77,7 @@ If you don't use emacs package manager please insert below
code into your ~/.ema
;; so below line is NOT needed.
;; But please put it *ABOVE* the (require 'evil-nerd-commenter)!!!
;; Please note if you use evil-leader, (setq evilnc-hotkey-comment-operator
"\\\\")
-;; does NOT work! You need set up the hot key for command
"evilnc-comment-operator" directly.
+;; does NOT work! You need set up the hotkey for command
"evilnc-comment-operator" directly.
;; Check the end of README for sample setup
(setq evilnc-hotkey-comment-operator ",,")
(require 'evil-nerd-commenter)
@@ -89,14 +85,14 @@ If you don't use emacs package manager please insert below
code into your ~/.ema
#+END_SRC
* Usage
-** Available commands and hot keys
+** Available commands and hotkeys
Here are available commands. They are not dependent on
[[http://emacswiki.org/emacs/Evil][evil-mode]]:
*** evilnc-comment-or-uncomment-lines (RECOMMENDED)
comment/uncomment lines. This command supports negative arguments.
The hotkey is ",ci" in evil-mode and "M-;" (M means Alt key) in emacs normal
mode.
-*This may be the only command and hot key you need to learn!*
+*This may be the only command and hotkey you need to learn!*
*** evilnc-quick-comment-or-uncomment-to-the-line (RECOMMENDED)
comment/uncomment from current line to the user-specified line. You can input
the rightest digit(s) to specify the line number if you want to type less.
@@ -121,7 +117,7 @@ Copy from the current line to the user-specified line.
It's *for non-evil user only*.
-You need assign hot key for it.
+You need assign hotkey for it.
For example:
#+BEGIN_SRC elisp
@@ -138,7 +134,7 @@ Kill from the current line to the user-specified line.
It's *for non-evil user only*.
-You need assign hot key for it.
+You need assign hotkey for it.
For example:
#+BEGIN_SRC elisp
@@ -149,19 +145,19 @@ For example:
Comment to the specified line. evilnc-quick-comment-or-uncomment-to-the-line
may be better alternative.
** Examples
-*** Example 1
+*** Comment lines
"C-u NUM M-x evilnc-comment-or-uncomment-lines", comment/uncomment next NUM
lines.
-*** Example 2
+*** Comment region
Select a region and "M-x evilnc-comment-or-uncomment-lines". The region will
be *automatically expanded to contain whole lines*. Then we comment/uncomment
the region.
-*** Example 3
+*** Comment to the line number
"C-u 56 M-x evilnc-comment-or-uncomment-to-the-line", comment/uncomment *from
current line* to line 56.
-*** Example 4
+*** Copy and comment
"C-u 2 M-x evilnc-copy-and-comment-lines", copy 2 lines and paste them below
the original line. Then comment out original lines. The focus will be moved to
the new lines.
-*** Example 5
+*** Comment paragraph
"C-u 2 M-x evilnc-comment-or-uncomment-paragraphs", comment out two
paragraphs. This is useful if you have large hunk of data to be commented out
as below:
#+BEGIN_SRC javascript
var myJson={
@@ -171,7 +167,7 @@ var myJson={
}
#+END_SRC
-*** Example 6
+*** Invert comment
Say there are two lines of javascript code,
#+BEGIN_SRC javascript
if(flag==true){ doSomething(); }
@@ -182,13 +178,11 @@ The first line is production code. The second line is
your debug code. You want
All you need to is "M-x evilnc-toggle-invert-comment-line-by-line" then "C-u 2
evilnc-comment-or-uncomment-lines". The first command turn on some flag, so the
behavior of (un)commenting is different.
* Evil usage
-If you use [[http://emacswiki.org/emacs/Evil][evil-mode]], you get an operator
that works with all the usual
[[http://vimdoc.sourceforge.net/htmldoc/motion.html#text-objects][text objects
and motions]].
-
-Please note all the features listed here are dependent on
[[http://emacswiki.org/emacs/Evil][evil-mode]]. So if you want to use these
features you need install evil.
+If you use [[http://emacswiki.org/emacs/Evil][Evil]], you can use
[[http://vimdoc.sourceforge.net/htmldoc/motion.html#text-objects][text objects
and motions]].
"evilnc-hotkey-comment-operator" acts much like the delete/change operator.
Takes a motion or text object and comments it out, yanking its content in the
process.
-By default we assign the hot key ",," to evilnc-hotkey-comment-operator.
+By default we assign the hotkey ",," to evilnc-hotkey-comment-operator. If you
prefer backslash key, check the next section "Tip 4" in next section.
Here is sample elisp code:
#+BEGIN_SRC elisp
@@ -212,7 +206,7 @@ Example 7: ",,it", comment the region inside html tags (all
html major modes are
* Tips
** Tip 1, Yank in evil-mode
-You can yank to line 99 using hot key "y99G" or "y99gg". That's the awesome
feature from evil-mode. Please read vim manual on "text objects and motions"
for more details.
+You can yank to line 99 using hotkey "y99G" or "y99gg". That's the awesome
feature from evil-mode. Please read vim manual on "text objects and motions"
for more details.
** Tip 2, change comment style
For example, use double slashes (//) instead of slash-stars (/* ... */) in
c-mode.
@@ -254,5 +248,8 @@ Most popular programming languages are supported;
)
#+END_SRC
+** Tip 5, (un)comment Lisp code
+- Make sure Evil installed
+- Press ",,a("
* Contact me
-You can report bugs at [[https://github.com/redguardtoo/evil-nerd-commenter]].
+Report bug at [[https://github.com/redguardtoo/evil-nerd-commenter]].
