X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fvimcoder;a=blobdiff_plain;f=README.md;h=0872d107c5058bf6a4ec913a84297ee6089df437;hp=7068851fce9ff93f855ad1300b2b7278a012dc7a;hb=a591f0fce8ebccd87f2e199479a0f91ad182f003;hpb=c207038cc35932ef12270d1d44f6d3385b998cf4 diff --git a/README.md b/README.md index 7068851..0872d10 100644 --- a/README.md +++ b/README.md @@ -182,8 +182,7 @@ template. If you are using the default Makefile template for C++, typing ":make" without any arguments will compile your code. Typing ":make run" will run all of the test cases against your code. Typing ":make test" will also run the test -cases against your code, up until the first failed test at which point it will -abort. +cases against your code, except it will abort at the first failed test. A Makefile template is not yet provided for any other language, but you can write one yourself if you are so inclined. Read on to learn how templates @@ -210,6 +209,13 @@ set to C++, the driver code would be in the driver.cc file. You normally don't have to do anything with this file. It just provides supporting code for running the test cases against your code. +The driver should output TAP (Test Anything Protocol) so that tests can be run +in a test harness such as [prove](http://search.cpan.org/perldoc?prove). The +default Makefile template has a `prove` target (type ":make prove") that can +run the tests in a test harness; the test harness is `prove` unless otherwise +configured. TAP output is also very human-readable all by itself, so having +a test harness isn't really required. + A default driver template is currently only provided for the C++ language. You could write your own template if you wanted to.