branch: elpa/evil-matchit
commit f7bced45002d035fd77c92aed70b9434e39ba73f
Author: Chen Bin <[email protected]>
Commit: Chen Bin <[email protected]>
updated README
---
README.org | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/README.org b/README.org
index f450840064..0d06a07461 100644
--- a/README.org
+++ b/README.org
@@ -23,13 +23,12 @@ Most modern languages are supported:
This package uses Evil as its vi layer!
* Why use evil-matchit
-- No learning curve. You only need press "%" to jump between matched tags.
That's all!
-- Stable! The ONLY dependency is evil-mode which I use minimum of its APIs. So
it should work in any major modes (web-mode, html-mode ...).
+- No learning curve. Press "%" to jump between matched tags. That's all!
+- Stable! The ONLY dependency is evil-mode. So it should work in any major
modes (web-mode, html-mode ...).
- Support any modern languages (html/java/c/c++/python/latex/javascript ...).
-- Powerful. For example, if you mix jsp, freemarker, html, jquery template or
any wierd sytax into one file, evil-matchit still works!
+- Powerful. For example, if you mix jsp, freemarker, html, jquery template or
any weird syntax into one file, evil-matchit still works!
- Extendable. You can write a plugin for it in 5 minutes.
-- Many languages will be supported soon.
-- I will provide long term support for it (say next 10 years) because Emacs is
my last editor.
+- I will provide long term support for it (next 10 years) because Emacs is my
last editor.
Here is screen cast for python:
[[file:screencast.gif]]
@@ -81,7 +80,7 @@ Say you embed python language in a html file. You can match
both html tags and p
** re-define keybinding
You can define your own key bindings instead using evil-matchit default key
binding.
-All you need to do is define function evilmi-customize-keybinding before
turning on evil-mathcit-mode:
+All you need to do is to define function evilmi-customize-keybinding before
turning on evil-mathcit-mode:
#+BEGIN_SRC elisp
(defun evilmi-customize-keybinding ()
(evil-define-key 'normal evil-matchit-mode-map
@@ -95,7 +94,7 @@ All you need to do is define function
evilmi-customize-keybinding before turning
* Developer guide
** Write elisp code to support a new language
-Simple. All you need to is define two functions and tell evil-matchit in which
major-mode they should be used.
+Simple. You only need define two functions and tell evil-matchit in which
major-mode they should be used.
Here is a complete sample:
#+BEGIN_SRC elisp
@@ -179,7 +178,7 @@ Simple, eh?
Basically you just need:
- copy the content of evil-matchit-script.el to your ~/.emacs
- Search and replace the string "_script" with "_mylang" to respect the name
space
-- Update the value of evilmi--mylan-match-tags
+- Update the value of evilmi--mylang-match-tags
- Notify the evil-matchit about support for new commands. As I mentioned
before, it's just one line code in ~/.emacs
#+BEGIN_SRC lisp
@@ -196,4 +195,4 @@ Key points about code quality of plugin:
- support emacs 23
- performance is the first priority
* Contact me
-You can report bugs at [[https://github.com/redguardtoo/evil-matchit]].
+You can report bugs at [[https://github.com/redguardtoo/evil-matchit]].
\ No newline at end of file
