[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

gnulib/README -> gnulib.texi

From: Karl Berry
Subject: gnulib/README -> gnulib.texi
Date: Sat, 21 Apr 2012 15:44:51 -0700

Someone asked me today about whether gnulib required C99.  I couldn't
remember the answer for sure (which is "no" :), so I went to look it up,
and was surprised to find it (as far as I could see) only in
gnulib/README and not gnulib.texi.  It looks like there were several
nontrivial sections in that 320-line README which are not in the manual.

So I was wondering ... opinions on reducing the README to essentially a
list of pointers with all the information in the manual?  Another (more
difficult) alternative would be to autogenerate the README from part of
the manual.

As an example of what I mean, here is the 50-line README I constructed
for a previous version of hello (sorry Reuben, can't easily look at the
new release right now :).


This is the README file for the GNU Hello distribution.
Hello prints a friendly greeting.  It also serves as a sample GNU
package, showing practices that may be useful for GNU projects.

  Copyright (C) 1992, 1993, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
  2002, 2004, 2005, 2006, 2010 Free Software Foundation, Inc.

  Copying and distribution of this file, with or without modification,
  are permitted in any medium without royalty provided the copyright
  notice and this notice are preserved.

See the files ./INSTALL* for building and installation instructions.

Primary distribution point: ftp://ftp.gnu.org/gnu/hello/
 automatic redirection: http://ftpmirror.gnu.org/hello
 list of mirrors for manual selection: http://www.gnu.org/prep/ftp.html

Home page: http://www.gnu.org/software/hello/

Mailing list: address@hidden
- please use this list for all discussion: bug reports, enhancements, etc.
- archived at: http://lists.gnu.org/pipermail/bug-hello
- anyone is welcome to join the list; to do so, visit
- there is no corresponding newsgroup.

Bug reports:
 Please include enough information for the maintainers to reproduce the
 problem.  Generally speaking, that means:
- the contents of any input files necessary to reproduce the bug
  and command line invocations of the program(s) involved (crucial!).
- a description of the problem and any samples of the erroneous output.
- the version number of the program(s) involved (use --version).
- hardware, operating system, and compiler versions (uname -a).
- unusual options you gave to configure, if any (see config.status).
- anything else that you think would be helpful.

Patches are most welcome; if possible, please make them with diff -c and
include ChangeLog entries.

See README-dev for information on the development environment -- any
interested parties are welcome.  If you're a programmer and wish to
contribute, this should get you started.  If you're not a programmer,
your help in writing test cases, checking the documentation against the
implementation, translating the program strings to other languages,
etc., would still be very much appreciated.

The basic Hello algorithm was described by B.W. Kernighan and
D.M. Ritchie.  The GNU implementation is substantially more complex, in
order to be a canonical example of a GNU package.  Many people have
contributed; please see the ./AUTHORS and ./ChangeLog files.

GNU Hello is free software.  See the file COPYING for copying conditions.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]