[nongnu] elpa/evil-nerd-commenter c41c462d50 065/235: clean the doc v1.2.8

[ELPA Syncer]

branch: elpa/evil-nerd-commenter
commit c41c462d50f95edaa716a6533fd501c34c6f9cac
Author: Chen Bin <chenbin.sh@gmail.com>
Commit: Chen Bin <chenbin.sh@gmail.com>

    clean the doc v1.2.8
---
 README.org                 | 88 +++++++++++++++++++++++++++++++++++-----------
 evil-nerd-commenter-pkg.el |  2 +-
 evil-nerd-commenter.el     |  2 +-
 pkg.sh                     |  2 +-
 4 files changed, 70 insertions(+), 24 deletions(-)

diff --git a/README.org b/README.org
index 6fc2bc0e43..0de4581cea 100644
--- a/README.org
+++ b/README.org
@@ -1,4 +1,4 @@
-* evil-nerd-commenter (current version 1.2.7)
+* evil-nerd-commenter (version 1.2.8)
 
 *Please note this program could be used independently without evil-mode!*
 
@@ -12,7 +12,7 @@ I highly recommend you use it with 
[[http://gitorious.org/evil][evil]].
 
 Evil makes you take advantage of power of Vi to comment lines in shocking 
speed. For example, you can press key `,,99j` or `99,ci` to comment out 99 
lines.
 
-* Why evil-nerd-commenter is better? 
+* Why evil-nerd-commenter is better?
 ** A simple use case on the efficiency
 Say you want to comment out nine lines. Instead pressing "C-space M-9 C-n 
M-;", now you can press "M-9 M-;" or ",,9j" or "9,ci".
 
@@ -22,12 +22,12 @@ So you strike less keys than the original "M-x 
comment-dwim".
 
 Here is the live demo:
 
[[https://raw.github.com/redguardtoo/evil-nerd-commenter/master/evil-nerd-commenter-demo.gif]]
-** The commenter will ALWAYS work even the official Emacs has some bug
-I'll provide long-term support for this plugin for *ANY language* in the 
future. Here is a example how I work around 
[[https://github.com/redguardtoo/evil-nerd-commenter/issues/3][a bug in 
autoconf.el]]. 
+** It will even fix Emacs bug for you
+I'll provide long-term support for this plugin for *ANY language* in the 
future. Here is a example how I work around 
[[https://github.com/redguardtoo/evil-nerd-commenter/issues/3][a bug in 
autoconf.el]].
 * Install
 evil-nerd-commenter is already uploaded to [[http://marmalade-repo.org/]]. So 
the best way to install it is using Emacs' package manager.
 * Set up
-** The easy way (recommended)
+** The easy way (RECOMMENDED)
 Nothing to set up if install it in the way as I suggested.
 
 You may add one line of emacs lisp code into ~/.emacs to let 
evil-nerd-commenter assign hot keys for you:
@@ -86,29 +86,75 @@ If you don't use emacs package manager (Why?) to install 
evil-nerd-commenter the
 #+END_SRC
 
 * Usage
+** Available commands and hot keys
 Here are available commands. They are not dependent on 
[[http://emacswiki.org/emacs/Evil][evil-mode]]:
-- evilnc-comment-or-uncomment-lines :: comment/uncomment lines. This command 
supports negative arguments.
-- evilnc-comment-or-uncomment-to-the-line :: comment/uncomment from current 
line to the specified line.
-- evilnc-copy-and-comment-lines :: copy and paste lines, then comment out 
original lines. This command supports negative arguments.
-- evilnc-comment-or-uncomment-paragraphs :: comment/uncomment paragraphs which 
separated by empty lines
-- evilnc-toggle-comment-empty-lines :: toggle the flag to comment/uncomment 
empty lines
-- evilnc-copy-to-line :: Copy from the current line to the user specified 
line, for *non-evil user* only, you need set hot key for it.
-- evilnc-toggle-invert-comment-line-by-line :: toggle flag 
evilnc-invert-comment-line-by-line. When this flag is true, the command 
"evilnc-comment-or-uncomment-lines", "evilnc-comment-or-uncomment-to-the-line", 
and "evilnc-comment-or-uncomment-paragraphs" behavior will. They will *invert* 
each line's comment status.
-- evilnc-kill-to-line :: Kill from the current line to the user specified 
line, for *non-evil* user only, you need set hot key for it.
-
-Example 1:
+*** evilnc-comment-or-uncomment-lines (HIGHLY 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!*
+*** evilnc-comment-or-uncomment-to-the-line  (RECOMMENDED)
+comment/uncomment from current line to the user-specified line.
+
+The hotkey is ",cl" in evil-mode and "C-c l" (C means Ctrl key) in emacs 
normal mode.
+
+*** evilnc-copy-and-comment-lines (RECOMMENDED)
+copy and paste lines, then comment out original lines. This command supports 
negative arguments.
+
+
+The hotkey is ",cc" in evil-mode and "C-c c" in emacs normal mode.
+
+*** evilnc-comment-or-uncomment-paragraphs (HIGHLY RECOMMENDED)
+comment/uncomment paragraphs which separated by empty lines
+
+*** evilnc-toggle-comment-empty-lines
+toggle the flag to comment/uncomment empty lines.
+
+*** evilnc-copy-to-line
+Copy from the current line to the user-specified line.
+
+It's *for non-evil user only*.
+
+You need assign hot key for it.
+
+For example:
+#+BEGIN_SRC elisp
+(global-set-key (kbd "C-c C-t C-l") 'evilnc-copy-to-line)
+#+END_SRC
+
+
+*** evilnc-toggle-invert-comment-line-by-line
+Toggle flag evilnc-invert-comment-line-by-line. When this flag is true, the 
command "evilnc-comment-or-uncomment-lines", 
"evilnc-comment-or-uncomment-to-the-line", and 
"evilnc-comment-or-uncomment-paragraphs" will be influenced.
+
+These commands will *invert* each line's comment status instead comment the 
whole thing.
+
+*** evilnc-kill-to-line
+Kill from the current line to the user-specified line.
+
+It's *for non-evil user only*.
+
+You need assign hot key for it.
+
+For example:
+#+BEGIN_SRC elisp
+(global-set-key (kbd "C-c C-t C-l") 'evilnc-kill-to-line)
+#+END_SRC
+
+** Examples
+*** Example 1
 "C-u NUM M-x evilnc-comment-or-uncomment-lines", comment/uncomment next NUM 
lines.
 
-Example 2:
+*** Example 2
 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:
+*** Example 3
 "C-u 56 M-x evilnc-comment-or-uncomment-to-the-line", comment/uncomment *from 
current line* to line 56.
 
-Example 4:
+*** Example 4
 "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:
+*** Example 5
 "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={
@@ -118,7 +164,7 @@ var myJson={
 }
 #+END_SRC
 
-Example 6:
+*** Example 6
 Say there are two lines of javascript code,
 #+BEGIN_SRC javascript
 if(flag==true){ doSomething(); }
@@ -133,7 +179,7 @@ If you use [[http://emacswiki.org/emacs/Evil][evil-mode]], 
you get an operator t
 
 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.
 
-- 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.  
+"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.
 
diff --git a/evil-nerd-commenter-pkg.el b/evil-nerd-commenter-pkg.el
index 6bf7fb747b..bc98e0a275 100644
--- a/evil-nerd-commenter-pkg.el
+++ b/evil-nerd-commenter-pkg.el
@@ -1,2 +1,2 @@
-(define-package "evil-nerd-commenter" "1.2.7"
+(define-package "evil-nerd-commenter" "1.2.8"
                 "Comment/uncomment lines efficiently. Like Nerd Commenter in 
Vim")
diff --git a/evil-nerd-commenter.el b/evil-nerd-commenter.el
index d9ab951596..d609b8e94d 100644
--- a/evil-nerd-commenter.el
+++ b/evil-nerd-commenter.el
@@ -4,7 +4,7 @@
 
 ;; Author: Chen Bin <chenbin.sh@gmail.com>
 ;; URL: http://github.com/redguardtoo/evil-nerd-commenter
-;; Version: 1.2.7
+;; Version: 1.2.8
 ;; Keywords: commenter vim line evil
 ;;
 ;; This file is not part of GNU Emacs.
diff --git a/pkg.sh b/pkg.sh
index 3371b7317b..043a054c0f 100755
--- a/pkg.sh
+++ b/pkg.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-pkg=evil-nerd-commenter-1.2.7
+pkg=evil-nerd-commenter-1.2.8
 mkdir $pkg
 cp README.org $pkg
 cp *.el $pkg