From e1e12f0b419461c4fc63461a2776024ad9f4fd54 Mon Sep 17 00:00:00 2001 From: Terence Parr Date: Thu, 22 Jan 2015 17:52:07 -0800 Subject: [PATCH] update readme --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a9f3a04333..731a87743d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,18 @@ **ANTLR** (ANother Tool for Language Recognition) is a powerful parser generator for reading, processing, executing, or translating structured text or binary files. It's widely used to build languages, tools, and frameworks. From a grammar, ANTLR generates a parser that can build parse trees and also generates a listener interface (or visitor) that makes it easy to respond to the recognition of phrases of interest. -* [Wikipedia](https://en.wikipedia.org/wiki/ANTLR) +## Authors and major contributors + +* [Terence Parr](http://www.cs.usfca.edu/~parrt/), parrt@cs.usfca.edu +ANTLR project lead and supreme dictator for life +[University of San Francisco](http://www.usfca.edu/) +* [Sam Harwell](http://tunnelvisionlabs.com/) (Tool co-author, Java and C# target) +* Eric Vergnaud (Javascript, Python2, Python3 targets and significant work on C# target) + +## Useful information + +* [Release notes](https://github.com/antlr/antlr4/releases) +* [Getting started with v4](https://theantlrguy.atlassian.net/wiki/display/ANTLR4/Getting+Started+with+ANTLR+v4) * [Official site](http://www.antlr.org/) * [Documentation](https://theantlrguy.atlassian.net/wiki/display/ANTLR4/ANTLR+4+Documentation) * [FAQ](https://theantlrguy.atlassian.net/wiki/display/ANTLR4/ANTLR+v4+FAQ) @@ -10,28 +21,21 @@ * [ANTLR v3](http://www.antlr3.org/) * [v3 to v4 Migration guide, differences](https://theantlrguy.atlassian.net/wiki/pages/viewpage.action?pageId=1900596) -[Release notes](https://github.com/antlr/antlr4/releases) - -*For installation and other getting started information, see [Getting started with v4](https://theantlrguy.atlassian.net/wiki/display/ANTLR4/Getting+Started+with+ANTLR+v4). You can also read about [building ANTLR itself](https://github.com/antlr/antlr4/wiki/How-to-build-ANTLR-itself).* +You might also find the following wiki pages useful, particularly if you want to mess around with the various target languages. + +* [How to build ANTLR itself](https://github.com/antlr/antlr4/wiki/How-to-build-ANTLR-itself) +* [How we create and deploy an ANTLR release](https://github.com/antlr/antlr4/wiki/Cutting-an-ANTLR-4-release) ## The Definitive ANTLR 4 Reference -You can buy a book [The Definitive ANTLR 4 Reference](http://pragprog.com/book/tpantlr2/the-definitive-antlr-4-reference) Programmers run into parsing problems all the time. Whether it’s a data format like JSON, a network protocol like SMTP, a server configuration file for Apache, a PostScript/PDF file, or a simple spreadsheet macro language—ANTLR v4 and this book will demystify the process. ANTLR v4 has been rewritten from scratch to make it easier than ever to build parsers and the language applications built on top. This completely rewritten new edition of the bestselling Definitive ANTLR Reference shows you how to take advantage of these new features. -[Book source code](http://pragprog.com/titles/tpantlr2/source_code) +You can buy the book [The Definitive ANTLR 4 Reference](http://amzn.com/1934356999) at amazon or an [electronic version at the publisher's site](https://pragprog.com/book/tpantlr2/the-definitive-antlr-4-reference). + +You will find the [Book source code](http://pragprog.com/titles/tpantlr2/source_code) useful. + ## Additional grammars [This repository](https://github.com/antlr/grammars-v4) is a collection of grammars without actions where the root directory name is the all-lowercase name of the language parsed by the grammar. For example, java, cpp, csharp, c, etc... - -## Authors and major contributors - -* [Terence Parr](http://www.cs.usfca.edu/~parrt/), parrt@cs.usfca.edu -ANTLR project lead and supreme dictator for life -[University of San Francisco](http://www.usfca.edu/) - -* [Sam Harwell](http://tunnelvisionlabs.com/) (Tool co-author, Java and C# target) - -* Eric Vergnaud (Javascript, Python2, Python3 targets and significant work on C# target)