summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAkim Demaille <akim.demaille@gmail.com>2020-04-04 10:42:21 +0200
committerAkim Demaille <akim.demaille@gmail.com>2020-04-04 10:56:46 +0200
commit4a55a5ea9a77d3803df7508793bf0058e700b83d (patch)
treee410a6caeb25e06030ff700759b6cab3f8acdf33 /README
parent72f04ca80fc8cd90da86529a55d45dc415eb5674 (diff)
downloadbison-4a55a5ea9a77d3803df7508793bf0058e700b83d.tar.gz
package: improve the readme
* README: Describe what Bison is.
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 19 insertions, 3 deletions
diff --git a/README b/README
index f8d79755..f5748c3c 100644
--- a/README
+++ b/README
@@ -1,4 +1,19 @@
-This package contains the GNU Bison parser generator.
+GNU Bison is a general-purpose parser generator that converts an annotated
+context-free grammar into a deterministic LR or generalized LR (GLR) parser
+employing LALR(1) parser tables. Bison can also generate IELR(1) or
+canonical LR(1) parser tables. Once you are proficient with Bison, you can
+use it to develop a wide range of language parsers, from those used in
+simple desk calculators to complex programming languages.
+
+Bison is upward compatible with Yacc: all properly-written Yacc grammars
+work with Bison with no change. Anyone familiar with Yacc should be able to
+use Bison with little trouble. You need to be fluent in C, C++ or Java
+programming in order to use Bison.
+
+Bison and the parsers it generates are portable, they do not require any
+specific compilers.
+
+GNU Bison's home page is https://gnu.org/software/bison/.
# Installation
## Build from git
@@ -103,7 +118,8 @@ fill-column: 76
ispell-dictionary: "american"
End:
-LocalWords: parsers ngettext Texinfo pdf html YYYY ZZZZ ispell american
-LocalWords: MERCHANTABILITY
+LocalWords: parsers ngettext Texinfo pdf html YYYY ZZZZ ispell american md
+LocalWords: MERCHANTABILITY GLR LALR IELR submodule init README src bw
+LocalWords: Relocatability symlinks symlink
-->