From 83c2e0f3690cae07a2134cd53d4fd159ff5695a0 Mon Sep 17 00:00:00 2001 From: ninrod Date: Tue, 2 Apr 2019 23:23:32 -0300 Subject: add a "make emacs" makefile option to fire up a clean emacs... - ...environment with just evil and evil-surround - additionally, alter readme to include a first CONTRIBUTING section draft. --- .gitignore | 1 + Makefile | 13 ++++++++++++- readme.org | 20 ++++++++++++++++++++ 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 397e90c..e6bfe19 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .elpa/ *.elc +evil/ diff --git a/Makefile b/Makefile index a9a8e86..1926247 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,16 @@ emacs ?= emacs bemacs = $(emacs) -batch -l test/elpa.el +LIBS = -L evil -L evil/lib -l evil.el -l goto-chg.el -l undo-tree.el -L . -l evil-surround.el -L test -l evil-surround-test.el update: - $(emacs) -batch -l test/make-update.el + $(emacs) -batch -l test/make-update.el && \ + [ ! -d evil ] && \ + git clone --depth 1 https://github.com/emacs-evil/evil.git + +emacs: + $(emacs) -Q $(LIBS) \ + --eval "(evil-mode 1)" \ + --eval "(global-evil-surround-mode 1)" compile: clean $(bemacs) -l test/make-compile.el @@ -10,7 +18,10 @@ compile: clean test: $(bemacs) -l test/make-test.el + clean: rm -f *.elc + + .PHONY: update compile test clean diff --git a/readme.org b/readme.org index c1b2a8a..ea2cafb 100644 --- a/readme.org +++ b/readme.org @@ -226,6 +226,26 @@ pressing return you would get This is due to an upstream change in =vim-surround=. It happened in this [[https://github.com/tpope/vim-surround/commit/6f0984a][commit]]. See the discussion in [[https://github.com/timcharper/evil-surround/pull/48][this]] pull request for more details. +* Contributing + - you are encouraged to test your changes a standard environment with a clean emacs and just the needed plugins + +** interactively + #+BEGIN_SRC sh + # open a shell and go to the evil-surround directory, after cloning it + make + make emacs + + # now load evil-surround/test/evil-surround-test.el and M-x ert and run the tests + #+END_SRC + +** command + + #+BEGIN_SRC sh + # open a shell and go to the evil-surround directory, after cloning it + make + make test + #+END_SRC + * Credits Credits and many [[https://github.com/emacs-evil/evil/issues/842][thanks]] go to [[http://github.com/timcharper][Tim Harper]], the original mantainer of the package. * LICENSE -- cgit v1.0