branch: elpa/guru-mode commit ba88b739f0f1885a3e85d64ef1aa4ac93cc6fb10 Author: Bozhidar Batsov <bozhi...@tradeo.com> Commit: Bozhidar Batsov <bozhi...@tradeo.com>
minor documentation update --- README.md | 19 +++++++++++++------ guru-mode.el | 8 ++++---- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9bc2287..2de0cfc 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,22 @@ Guru mode disables some common keybindings and suggests the use of the establish Just drop `guru-mode.el` somewhere in your `load-path`. I favour the folder `~/.emacs.d/vendor`: -``` +```lisp (add-to-list 'load-path "~/emacs.d/vendor") ``` -You can enable projectile globally like this: +You can enable `guru-mode` globally like this: -``` +```lisp (require 'guru-mode) -(guru-mode +1) ;; to enable in all buffers +(guru-global-mode +1) ;; to enable in all buffers +``` + +Most likely you'd like to enable `guru-mode` only in specific modes +(like `prog-mode` in Emacs 24): + +```lisp +(add-hook 'prog-mode-hook (lambda () (guru-mode +1))) ``` ## Marmalade @@ -31,7 +38,7 @@ you can install guru-mode from the [MELPA](http://melpa.milkbox.net/) repository ## Emacs Prelude -guru-mode is naturally part of the +`guru-mode` is naturally part of the [Emacs Prelude](https://github.com/bbatsov/prelude). If you're a Prelude -user - guru-mode is already properly configured and ready for +user - `guru-mode` is already properly configured and ready for action. diff --git a/guru-mode.el b/guru-mode.el index 420d01e..dac13d6 100644 --- a/guru-mode.el +++ b/guru-mode.el @@ -69,10 +69,6 @@ (define-key guru-mode-map (read-kbd-macro (first cell)) (guru-rebind (first cell) (rest cell)))) -;; define minor mode -;;;###autoload -(define-globalized-minor-mode guru-global-mode guru-mode guru-on) - (defun guru-on () "Enable Guru." (guru-mode +1)) @@ -87,5 +83,9 @@ :keymap guru-mode-map :group 'guru) +;; define global minor mode +;;;###autoload +(define-globalized-minor-mode guru-global-mode guru-mode guru-on) + (provide 'guru-mode) ;;; guru-mode.el ends here