30bd82f5d2cd

Add a README for the tests.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Fri, 12 Nov 2010 19:23:05 -0500
parents 2b3d5ee5c4a4
children 754d871449f1
branches/tags (none)
files tests/README.markdown

Changes

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/README.markdown	Fri Nov 12 19:23:05 2010 -0500
@@ -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.