skeletons: factor comments about symbols

[bison.git] / README

diff --git a/README b/README
index 9f415dfd408289e4f8ca0d456c5491d7ebbe316f..04bf5106105f8857a6fc93cbd0a1ffa0aa5df705 100644 (file)
--- a/README
+++ b/README
@@ -1,23 +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.

 
 

-It was once true that, when installing Bison on Sequent (or Pyramid?)
-systems, you had to be in the Berkeley universe.  This may no longer
-be true; we have no way to tell.
+Bison requires GNU m4 1.4.6 or later.  See:

 
 

-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

 
 

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

 
 

-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.
+* 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 which the documentation does
-not answer, send mail to help-bison@gnu.org.
+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-2005, 2008-2012 Free Software
+Foundation, Inc.
+
+This file is part of Bison, the GNU Compiler Compiler.
+
+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
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+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
+along with this program.  If not, see <http://www.gnu.org/licenses/>.