doc: explain how mid-rule actions are translated

[bison.git] / README

diff --git a/README b/README
index a2ae26ba5871e437c5623f1ad9e77d537602f238..04bf5106105f8857a6fc93cbd0a1ffa0aa5df705 100644 (file)
--- a/README
+++ b/README
@@ -1,27 +1,51 @@
-This directory contains the Bison parser generator.
+This package contains the GNU Bison parser generator.
 
-See the file INSTALL for generic compilation and installation instructions.
-See the file doc/FAQ for frequently asked questions.
+* Installation
+** Build
+See the file INSTALL for generic compilation and installation
+instructions.
 
-Bison requires GNU m4 1.4.3 or later.  See:
+Bison requires GNU m4 1.4.6 or later.  See:
 
-ftp://ftp.gnu.org/gnu/m4/m4-1.4.3.tar.gz
+      ftp://ftp.gnu.org/gnu/m4/m4-1.4.6.tar.gz
 
-Bison can work with pre-1.4.3 distributions of GNU m4 if they are
-sufficiently patched, but if you encounter a bug with an older
-distribution and report a bug we will probably suggest that you
-upgrade to 1.4.3 as the first step in trying to fix it.
+** Internationalization
+Bison supports two catalogues: one for Bison itself (i.e., for the
+maintainer-side parser generation), and one for the generated parsers
+(i.e., for the user-side parser execution).  The requirements between
+both differ: bison needs ngettext, the generated parsers do not.  To
+simplify the build system, neither are installed if ngettext is not
+supported, even if generated parsers could have been localized.  See
+http://lists.gnu.org/archive/html/bug-bison/2009-08/msg00006.html for
+more details.
 
+* Questions
+See the section FAQ in the documentation (doc/bison.info) for
+frequently asked questions.  The documentation is also available in
+PDF and HTML, provided you have a recent version of Texinfo installed:
+run "make pdf" or "make html".
+
+If you have questions about using Bison and the documentation does
+not answer them, please send mail to <help-bison@gnu.org>.
+
+* Bug reports
 Please send bug reports to <bug-bison@gnu.org>.  Please include the
 version number from `bison --version', and a complete, self-contained
 test case in each bug report.
 
-If you have questions about using Bison and the documentation does
-not answer them, please send mail to <help-bison@gnu.org>.
+* Copyright statements
+For any copyright year range specified as YYYY-ZZZZ in this package,
+note that the range specifies every single year in that closed interval.
+
+
+Local Variables:
+mode: outline
+End:
 
 -----
 
-Copyright (C) 1992, 1998, 1999, 2003, 2004, 2005 Free Software Foundation, Inc.
+Copyright (C) 1992, 1998-1999, 2003-2005, 2008-2012 Free Software
+Foundation, Inc.
 
 This file is part of Bison, the GNU Compiler Compiler.