From f6162a7b5a65a297c8ebb8a81ce6e1278f958bbc Mon Sep 17 00:00:00 2001 From: ninrod Date: Fri, 1 Dec 2017 23:15:12 -0200 Subject: closes #112 --- readme.org | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/readme.org b/readme.org index 9fe80e7..011ad14 100644 --- a/readme.org +++ b/readme.org @@ -8,17 +8,23 @@ [[https://user-images.githubusercontent.com/8352747/33156355-1a2477d8-cfe0-11e7-93e7-47cc33821e37.png][https://user-images.githubusercontent.com/8352747/33156355-1a2477d8-cfe0-11e7-93e7-47cc33821e37.png]] This package emulates [[https://github.com/tpope/vim-surround][surround.vim]] by [[https://github.com/tpope][Tim Pope]]. The functionality is wrapped into a minor mode. -To enable it globally, add the following lines to ~/.emacs: + +This package uses [[https://github.com/emacs-evil/evil][Evil]] as its vi layer. + +* Installation + +To enable it through [[https://github.com/jwiegley/use-package][use-package]], add the following lines to =~/.emacs= or =~/.emacs.d/init.el=: #+BEGIN_SRC emacs-lisp -(require 'evil-surround) -(global-evil-surround-mode 1) + (use-package evil-surround + :ensure t + :config + (global-evil-surround-mode 1)) #+END_SRC -Alternatively, you can enable =surround-mode= along a major mode by adding -=turn-on-surround-mode= to the mode hook. +Alternatively, can add the =evil-surround.el= file to your load-path and add =(require 'evil-surround)= to your init file. -This package uses [[https://github.com/emacs-evil/evil][Evil]] as its vi layer. +Also, Instead of enabling it globally, you can also enable =surround-mode= along a major mode by adding =turn-on-surround-mode= to the mode hook. * Usage ** Add surrounding -- cgit v1.0