From ea3e5eb3159d97ee77e2ed9dc67385d7e41c2f64 Mon Sep 17 00:00:00 2001 From: Steve Losh Date: Fri, 12 Nov 2010 19:23:05 -0500 Subject: [PATCH] Add a README for the tests. --- tests/README.markdown | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 tests/README.markdown diff --git a/tests/README.markdown b/tests/README.markdown new file mode 100644 index 0000000..9e7f26c --- /dev/null +++ b/tests/README.markdown @@ -0,0 +1,21 @@ +This is Gundo's test suite. In case you didn't know, unit testing vim plugins +is a horrible experience. + +Gundo bundles Luc Hermitte's [UT][] framework to make the process less painful. + +[UT]: http://code.google.com/p/lh-vim/wiki/UT + +To run a test, `cd` into the `tests` directory and use: + + ./run-tests.sh [TEST FILE].vim + +The script will run the console vim command with its own vimrc and .vim +directory, so none of your other plugins should interfere. The result of the +tests will be shown in the quickfix window of this vim instance. + +The `q` key will be remapped to perform `:qa!` so you can close everything +quickly if it all looks good. + +The `run-tests.sh` script is still a work in progress. I need to figure out +a good way of running multiple tests and collecting results. Suggestions +and/or patches are very welcome.