1ANTLR v3.1 .NET Runtime Library (for us with the ANTLR C# Code Generator)
2
329 September, 2007
4
5Kunle Odutola		: kunle UNDERSCORE odutola AT hotmail DOT com
6Micheal Jordan
7
81. INTRODUCTION 
9
10The ANTLR v3.1 .NET Runtime Library extend the ANTLR language processing 
11tools generator to the C#/CLI platforms such as Microsoft .NET, 
12Novell/Ximian Mono and dotGNU. It is written in the C# programming language 
13and was designed specifically for use with the ANTLR C# Code Generation
14target but, it would work equally well with a VB.NET, C++/CLI or indeed 
15IronPython code generator were such a thing to be developed for ANTLR v3.1.
16
17We hope you find the ANTLR v3.1 .NET Runtime Library delightful and useful 
18even but, as per the license under which you may use it, this software is not 
19guaranteed to work.
20
21Please see LICENSE.TXT for the full text of the license and NOTICE.TXT 
22for attribution notices.
23
24
252. WHAT'S IN THE PACK?
26
27This distribution contains three projects, the project files needed to 
28build them with Microsoft Visual Studio 2003 & 2005 and, Nant build files.
29
30The projects are:
31
32	1. Antlr3.Runtime           - the ANTLR v3.1 .NET Runtime Library
33
34	2. Antlr3.Utility           - the ANTLR v3.1 .NET Runtime Utility Library
35
36	3. Antlr3.Runtime.Tests     - the ANTLR v3.1 .NET Runtime Library Tests
37
38In addition the Libraries sub-directory contains externals dependencies.
39
402.1 Dependencies
41
42   1. Antlr3.Runtime           - none
43
44   2. Antlr3.Utility           - Antlr3.Runtime.dll
45                                 StringTemplate.dll
46                                 antlr.runtime.dll
47
48   3. Antlr3.Runtime.Tests     - Antlr3.Runtime.dll
49                                 StringTemplate.dll
50                                 antlr.runtime.dll
51
52In addition, Antlr3.Runtime.Tests has a dependency on the MbUnit v2.4 dlls.
53
54
553. USING The ANTLR v3.1 .NET Runtime Library
56
57Tou use the ANTLR v3.1 .NET Runtime Library in your projects, add a 
58reference to the following file in your projects:
59  - Antlr3.Runtime.dll
60  
61If you are using StringTemplate out in your grammar, add the following 
62files too:  
63  - StringTemplate.dll 
64  - antlr.runtime.dll
65
66You can find examples of using ANTLR v3.1 and the ANTLR v3.1 .NET Runtime 
67Library at:
68  http://www.antlr.org/download/examples-v3.tar.gz
69
70
714. BUILDING The ANTLR v3.1 .NET Runtime Library
72
73If you wish to re-build The ANTLR v3.1 .NET Runtime Library for any reason, this 
74is what you need to know.
75
76    nant clean
77	nant release -t:net-1.1
78or
79    nant clean
80	nant release -t:net-2.0
81
82
835. ANTLR v3.1 .NET Runtime Library STATUS
84
85This release of the ANTLR v3.1 .NET Runtime Library is a stable beta release.
86
87There are currently 0 failures in the unit test suite.
88
89
90Don't forget to visit the www.antlr.org for further info. The mailing lists 
91are (currently) low volume and have a very high Signal-to-Noise ratio. We'd 
92like to hear about how you're using ANTLR v3.1 and the .NET Runtime Library.
93
94
957. CONTRIBUTORS
96
97Kunle Odutola
98Micheal Jordan
99
100
101Enjoy!
102
103Kunle Odutola
104