maint: Valgrind on OS X.

[bison.git] / README

diff --git a/README b/README
index 8d2153be3d5e673a354cb6b9530d03d12a10624a..04bf5106105f8857a6fc93cbd0a1ffa0aa5df705 100644 (file)
--- a/README
+++ b/README
@@ -1,43 +1,63 @@
-This directory contains the Bison parser generator.
+This package contains the GNU Bison parser generator.

 
 

-See the file INSTALL for 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.

 
 

-Older versions of Sun Forte Developer 6 update 2 have a compiler bug
-that cause "make check" to fail with a "Encounter BINCL entry"
-diagnostic.  To fix the bug, update to the latest set of Solaris and
-Forte patches recommended by Sun.
+Bison requires GNU m4 1.4.6 or later.  See:

 
 

-VMS and MS-DOS builds are probably broken right now.  If you are able
-to build Bison on either platform and you need to make changes to do
-so, please submit those changes as a bug report.  On VMS, you will
-probably have to create Makefile from Makefile.in by hand.  Remember
-to do `SET COMMAND BISON' to install the data in `BISON.CLD'.
+      ftp://ftp.gnu.org/gnu/m4/m4-1.4.6.tar.gz

 
 

-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.
+** 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.

 
 

-If you have questions about using Bison which the documentation does
-not answer, send mail to <help-bison@gnu.org>.
+* 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.
+
+* 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 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.
 
 
 This file is part of Bison, the GNU Compiler Compiler.
 

-Bison is free software; you can redistribute it and/or modify
+This program is free software: you can redistribute it and/or modify

 it under the terms of the GNU General Public License as published by
 it under the terms of the GNU General Public License as published by

-the Free Software Foundation; either version 2, or (at your option)
-any later version.
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.

 
 

-Bison is distributed in the hope that it will be useful,
+This program is distributed in the hope that it will be useful,

 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License

-along with autoconf; see the file COPYING.  If not, write to
-the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.
+along with this program.  If not, see <http://www.gnu.org/licenses/>.