From 45282c1476a085677813719c5dae00a7b8b2b8f3 Mon Sep 17 00:00:00 2001 From: James Nguyen Date: Sun, 14 Jan 2018 12:21:11 -0800 Subject: [PATCH] Readme: Clarify and fix some errors --- readme.org | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/readme.org b/readme.org index b145bae..989fb2b 100644 --- a/readme.org +++ b/readme.org @@ -39,31 +39,21 @@ Or clone / download this repository and modify your ~load-path~: : (add-to-list 'load-path (expand-file-name "/path/to/evil-collection/" user-emacs-directory)) -- Register the bindings, either all at once: +- Register the bindings, either all at once with ~evil-collection-init~: or mode-by-mode, for instance: : (with-eval-after-load 'calendar (require 'evil-collection-calendar) (evil-collection-calendar-setup)) -The list of supported modes is simply the list of files. +The list of supported modes is configured by ~~evil-collection-mode-list~~. -If you want to enable Evil in the minibuffer, you'll have to turn it on -explicitly by customizing ~evil-collection-setup-minibuffer~ to ~t~. This is so -because many users find it confusing. - -~use-package~ example: - -: (use-package evil-collection -: :custom (evil-collection-setup-minibuffer t) -: :init (evil-collection-init)) - -~evil-collection~ also assumes ~evil-want-integration~ is set to nil before loading ~evil~ and ~evil-collection.~ +~evil-collection~ assumes ~evil-want-integration~ is set to nil before loading ~evil~ and ~evil-collection.~ For example: #+begin_src emacs-lisp :tangle yes (setq evil-want-integration nil) -(require evil) +(require 'evil) (when (require 'evil-collection nil t) (evil-collection-init)) #+end_src @@ -85,6 +75,9 @@ Here's another full TLDR ~use-package~ example. (evil-collection-init)) #+end_src +NOTE: If you don't like surprises but still want to use ~evil-collection-init~, setting ~evil-collection-mode-list~ to nil +and adding each mode manually might be a better option. + ** Configuration Modify ~evil-collection-mode-list~ to disable or add any modes that should be evilified by ~evil-collection~. @@ -97,6 +90,17 @@ Here's another full TLDR ~use-package~ example. | evil-collection-setup-minibuffer | nil | Set up Vim style bindings in the minibuffer. | | evil-collection-setup-debugger-keys | t | Set up debugger keys for certain modes. | + For example, if you want to enable Evil in the minibuffer, you'll have to turn it on + explicitly by customizing ~evil-collection-setup-minibuffer~ to ~t~. + + ~use-package~ example: + + #+begin_src emacs-lisp :tangle yes + (use-package evil-collection + :custom (evil-collection-setup-minibuffer t) + :init (evil-collection-init)) + #+end_src + ** Guidelines The following rules serve as guiding principles to define the set of standard