README.txt
1gUnit
2Feb 21, 2009
3
4Leon, Jen-Yuan Su
5leonsu at mac com
6
7INTRODUCTION
8
9Welcome to gUnit! I've been working on gUnit from 2007 summer and
10this is a project in USF CS, sponsored by professor Terence Parr.
11
12You should use the latest ANTLR v3 with gUnit:
13
14http://www.antlr.org/download.html
15
16See the wiki document:
17
18http://www.antlr.org/wiki/display/ANTLR3/gUnit+-+Grammar+Unit+Testing
19
20Per the license in LICENSE.txt, this software is not guaranteed to
21work and might even destroy all life on this planet:
22
23THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
27INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33POSSIBILITY OF SUCH DAMAGE.
34
35----------------------------------------------------------------------
36
37EXAMPLES
38
39See the wiki tutorial of gUnit:
40
41 http://www.antlr.org/wiki/display/ANTLR3/gUnit+-+Grammar+Unit+Testing
42
43----------------------------------------------------------------------
44
45What is gUnit?
46
47gUnit is an unit testing framework for ANTLR grammars. It provides a
48simple way to write and run automated tests for grammars in a manner
49similar to what jUnit does for unit testing.
50
51----------------------------------------------------------------------
52
53How do I install gUnit?
54
55It is included in ANTLR v3; it needs both ANTLR and StringTemplate jars
56in CLASSPATH.
57