[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/evil-nerd-commenter 1cff8e027d 084/235: updated README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/evil-nerd-commenter 1cff8e027d 084/235: updated README |
Date: |
Thu, 6 Jan 2022 02:59:37 -0500 (EST) |
branch: elpa/evil-nerd-commenter
commit 1cff8e027d774e5377cbc165fd9e911b4c42d5d0
Author: Chen Bin <chenbin.sh@gmail.com>
Commit: Chen Bin <chenbin.sh@gmail.com>
updated README
---
README.org | 38 ++++++++++++++++++--------------------
1 file changed, 18 insertions(+), 20 deletions(-)
diff --git a/README.org b/README.org
index be1c05f172..ccda0d1418 100644
--- a/README.org
+++ b/README.org
@@ -2,45 +2,45 @@
*This program could be used independently WITHOUT evil-mode!*
-This program is [[http://www.vim.org/scripts/script.php?script_id=1218][Nerd
Commenter]] simulator which help you comment lines efficiently.
+It's [[http://www.vim.org/scripts/script.php?script_id=1218][Nerd Commenter]]
simulator which help you comment lines efficiently.
-Other useful utilities are added to make it better than the original VIM
plugin. For example, you can copy and comment lines in one step
+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 use it with [[http://gitorious.org/evil][evil]] though evil is
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 very efficient. For
example, you can press key `,,99j` or `99,ci` to comment out 99 lines.
+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.
* 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".
+If 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".
-The key point is you need *NOT* mark any text to comment line(s)!
+The point is that you need *NOT* mark any text to comment line(s)!
So you strike less keys than the original "M-x comment-dwim".
-Here is the live demo:
+Live demo:
[[https://raw.github.com/redguardtoo/evil-nerd-commenter/master/evil-nerd-commenter-demo.gif]]
** 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]].
+I'll provide long-term support for *ANY language* in the future. Here is an
example how I work around
[[https://github.com/redguardtoo/evil-nerd-commenter/issues/3][a bug in
autoconf.el]].
** Perfect integration with org-mode
-The programming language embedded in org file will automatically be detected
and *correct* comment syntax will be used!
+The code snippet embedded in org file will automatically be detected and
*correct* comment syntax will be used!
* Install
-evil-nerd-commenter is already uploaded to [[http://melpa.milkbox.net/]]. So
the best way to install it is using Emacs' package manager.
+evil-nerd-commenter is already uploaded to [[http://melpa.milkbox.net/]]. The
best way to install it is using Emacs' package manager.
* Set up
** The easy way (RECOMMENDED)
-Nothing to set up if install it in the way as I suggested.
+Nothing to set up.
-You may add one line of emacs lisp code into ~/.emacs to let
evil-nerd-commenter assign hot keys for you:
+You may add one line of emacs lisp code into ~/.emacs to use default hot keys,
#+BEGIN_SRC lisp
(evilnc-default-hotkeys)
#+END_SRC
And *that's ALL*!
-Further explanation, the content of evilnc-default-hotkeys is:
+The content of evilnc-default-hotkeys is:
#+BEGIN_SRC lisp
(defun evilnc-default-hotkeys ()
"Set the hotkeys of evil-nerd-comment"
@@ -59,11 +59,10 @@ Further explanation, the content of evilnc-default-hotkeys
is:
#+END_SRC
As you can see, the default hot key for commenting lines is "M-;" when you
don't use [[http://emacswiki.org/emacs/Evil][evil-mode]].
-The advantage of use "M-;" is you can set mark on the first line and scroll
several pages down and comment all the lines in that region by "M-;". The key
point here is you save the extra two key strikes to make marked region wrap the
whole content of first and last line.
-I prefer vi key binds. So I also use
[[http://emacswiki.org/emacs/Evil][evil-mode]]. Evil-mode is only *optional*!
Some people don't use it because they prefer emacs native key binding.
+You can set mark on the first line, scroll down, and comment *all the lines*
instead of selected region by "M-;".
-Feel free to copy the content of evilnc-default-hotkeys into your .emacs
instead calling it directly. So you can define your own hotkeys.
+You can copy the content of evilnc-default-hotkeys into .emacs instead calling
it directly.
** The hard way
If you don't use emacs package manager please insert below code into your
~/.emacs:
@@ -98,7 +97,7 @@ The hotkey is ",ci" in evil-mode and "M-;" (M means Alt key)
in emacs normal mod
*** 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.
-For example, say current line number is 497. "C-u 3 M-x
evilnc-quick-comment-or-uncomment-to-the-line" will comment to the line 503
beause the rightest digit of "503" is 3.
+For example, say current line number is 497. "C-u 3 M-x
evilnc-quick-comment-or-uncomment-to-the-line" will comment to the line 503
because the rightest digit of "503" is 3.
The hotkey is ",cl" or ",ll" in evil-mode and "C-c l" (C means Ctrl key) in
emacs normal mode.
@@ -228,7 +227,7 @@ Thanks for Andrew Pennebaker (aka mcandre) providing this
tip.
Please check my project
[[https://github.com/redguardtoo/evil-matchit][evil-matchit]]. You can press
",si" to select a region between tags and press "M-/" to comment the region.
All the popular programming languages are supported;
-** Tip 4, use evil-leader if you prefer the "\" as the leader character in
evil-mode
+** Tip 4, use evil-leader if you use the *backslash* as the leader key in
evil-mode
- Install [[https://github.com/cofi/evil-leader][evil-leader according to its
README]].
- Remove line "(evilnc-default-hotkeys)" from your ~/.emacs.
- Insert below code into you ~/.emacs,
@@ -251,6 +250,5 @@ All the popular programming languages are supported;
)
#+END_SRC
-
* Contact me
-You can report bugs at [[https://github.com/redguardtoo/evil-nerd-commenter]].
+You can report bugs at [[https://github.com/redguardtoo/evil-nerd-commenter]].
\ No newline at end of file
- [nongnu] elpa/evil-nerd-commenter cc31b0a602 059/235: Fixed type in save-excursion., (continued)
- [nongnu] elpa/evil-nerd-commenter cc31b0a602 059/235: Fixed type in save-excursion., ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter adb8ba60de 062/235: minor wording update, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 9450c91c71 063/235: Bufgix in evilnc--in-comment-p, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter d03db1baef 066/235: update doc on comment style, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 277ea53931 067/235: Fixed uncommenting line "spilling" to next line, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 5f09387d60 069/235: doc updated v1.2.9, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter c156331ed2 075/235: better comment to the line, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter a5ec49a54e 079/235: ad for evil-matchit, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 336ce1ab67 083/235: readme on using evil-leader, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 7ec8564adc 082/235: optimize code a little bit, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 1cff8e027d 084/235: updated README,
ELPA Syncer <=
- [nongnu] elpa/evil-nerd-commenter 20a242a085 087/235: tweak README, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 10dd7f8f1d 090/235: Merge branch 'tuhdo-master', ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter c2d8cd947e 089/235: remove some interacitve hint and fixed some bug, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter b9e34fe377 088/235: Prompt user for input and fix evilnc-kill-to-line, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter f9bdfa9a70 096/235: sample setup for evil-leader users v1.5.5, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter 23e4d4d1e1 097/235: updated doc, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter a88146b600 099/235: fixed: minor bug comment to the line v1.5.7, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter dfdaae43e9 106/235: Don't byte-compile the evil bits, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter ac03a92ae6 107/235: updated README v1.5.10, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-nerd-commenter ff0344ed82 110/235: updated README v1.5.12, ELPA Syncer, 2022/01/06