summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2000-09-26 14:40:42 +0000
committerBruno Haible <bruno@clisp.org>2000-09-26 14:40:42 +0000
commitc2c3c31500a2dead25ac906d671c3f58f4b0f624 (patch)
treef7bd66166f8d0ba1256e584360ed8ae086582c5f /README
parent98ccd377f12ab52bcb6e9af01442ddb0b84cbb73 (diff)
downloadgperf-c2c3c31500a2dead25ac906d671c3f58f4b0f624.tar.gz
Documentation update for 2.7.2.v2.7.2
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 17 insertions, 12 deletions
diff --git a/README b/README
index bd9d14e..92ec7d2 100644
--- a/README
+++ b/README
@@ -1,24 +1,29 @@
-While teaching a data structures course at University of California,
-Irvine, I developed a program called GPERF that generates perfect hash
-functions for sets of key words. A perfect hash function is simply:
+This is GNU gperf. It is a program that generates perfect hash
+functions for sets of key words. A perfect hash function is:
A hash function and a data structure that allows
recognition of a key word in a set of words using
exactly 1 probe into the data structure.
-The gperf.texinfo file explains how the program works, the form of the
-input, what options are available, and hints on choosing the best
-options for particular key word sets. The texinfo file is readable
-both via the GNU emacs `info' command, and is also suitable for
-typesetting with TeX.
+The doc/gperf.html file explains how the program works, the form of
+the input, what options are available, and hints on choosing the best
+options for particular key words set.
-The enclosed Makefile creates the executable program ``gperf'' and
-also runs some tests.
+See the file NEWS for a list of major changes in the current release.
+
+See the file INSTALL for compilation and installation instructions.
Output from the GPERF program is used to recognize reserved words in
the GNU C, GNU C++, and GNU Pascal compilers, as well as with the GNU
indent program.
-Happy hacking!
+For general documentation on the coding and usage standards
+this distribution follows, see the GNU standards document
+ftp://ftp.gnu.org/pub/gnu/standards.*, especially the 'Makefile
+Conventions', 'Configuration', and 'User Interfaces' sections.
+
+Mail suggestions and bug reports to both <bug-gnu-utils@gnu.org> and
+<gperf-bugs@lists.sourceforge.net>. When reporting bugs, please
+include in the subject line the package name and version (output of
+'gperf --version') for which you found a problem.
-Douglas C. Schmidt