diff options
Diffstat (limited to '.config/emacs/lisp/evil/README.md')
| -rw-r--r-- | .config/emacs/lisp/evil/README.md | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/.config/emacs/lisp/evil/README.md b/.config/emacs/lisp/evil/README.md new file mode 100644 index 0000000..b753ef5 --- /dev/null +++ b/.config/emacs/lisp/evil/README.md @@ -0,0 +1,83 @@ + + +[](https://github.com/emacs-evil/evil/actions/workflows/test.yml) +[](https://melpa.org/#/evil) +[](https://stable.melpa.org/#/evil) +[](http://elpa.nongnu.org/nongnu/evil.html) +[](https://evil.readthedocs.io/en/latest/?badge=latest) +[](https://www.gnu.org/licenses/gpl-3.0) + +Evil is an **e**xtensible **vi** **l**ayer +for [Emacs](http://www.gnu.org/software/emacs/). It emulates the main features +of [Vim](http://www.vim.org/), and provides facilities for writing custom +extensions. Also see our page on [EmacsWiki](http://emacswiki.org/emacs/Evil). + +# Installation + +See the +[official documentation](https://evil.readthedocs.io/en/latest/overview.html#installation-via-package-el) +for installation instructions. We recommend using *package.el*. + +As a quickstart, you can add the following code to your Emacs init +file. + +```elisp +;; Set up package.el to work with MELPA +(require 'package) +(add-to-list 'package-archives + '("melpa" . "https://melpa.org/packages/")) +(package-initialize) +(package-refresh-contents) + +;; Download Evil +(unless (package-installed-p 'evil) + (package-install 'evil)) + +;; Enable Evil +(require 'evil) +(evil-mode 1) +``` + +## Dependencies + +* Evil requires Emacs 24.1 or later. + +* Evil requires any of the following for `C-r`: + * `undo-redo` from Emacs 28 + * The [undo-tree] package (available via GNU ELPA) + * The [undo-fu] package (available via MELPA and NonGNU ELPA) + +* For the motions `g;` `g,` and for the last-change-register `.`, Evil + requires the [goto-chg.el](https://github.com/emacs-evil/goto-chg) + package (available via MELPA and NonGNU ELPA), which provides the + functions `goto-last-change` and `goto-last-change-reverse`. + +* For Emacs 24.1 and 24.2 Evil also requires + [cl-lib](https://elpa.gnu.org/packages/cl-lib.html). + +# Documentation + +The latest version of the documentation is readable online +[here](https://evil.readthedocs.io/en/latest/index.html). It is also +available as +[PDF](https://evil.readthedocs.io/_/downloads/en/stable/pdf/) and +as [EPUB](https://evil.readthedocs.io/_/downloads/en/stable/epub/). + +# Mailing list + +Evil is discussed at the +[gmane.emacs.vim-emulation](http://lists.ourproject.org/cgi-bin/mailman/listinfo/implementations-list) +mailing list. + +# IRC + +Visit us on `irc.libera.chat #evil-mode`. + +# Contribution + +See +[CONTRIBUTING.md](https://github.com/emacs-evil/evil/blob/master/CONTRIBUTING.md) +for guidelines for issues and pull requests. + +[undo-tree]: https://gitlab.com/tsc25/undo-tree +[undo-fu]: https://codeberg.org/ideasman42/emacs-undo-fu |
