gitstats: Add a description about the tests module
authorSverre Rabbelier <sverre@rabbelier.nl>
Mon, 28 Jul 2008 12:49:28 +0000 (28 14:49 +0200)
committerSverre Rabbelier <sverre@rabbelier.nl>
Mon, 28 Jul 2008 21:08:53 +0000 (28 23:08 +0200)
This gives a very brief description, not really giving a
lot of information. It should probably be extended later
to give some more information.

doc/tests.txt [new file with mode: 0644]

diff --git a/doc/tests.txt b/doc/tests.txt
new file mode 100644 (file)
index 0000000..377e833
--- /dev/null
@@ -0,0 +1,8 @@
+syntax: stats.py tests <options>
+
+The purpose of the tests module is to make available the
+unittests for GitStats to external programs. It may be
+used to run the unittests for GitStats from for example
+a shell script. It's output is made to match the git
+regression test suite.
+