Revise README.
authorMatt McCutchen <matt@mattmccutchen.net>
Thu, 31 Jan 2008 01:53:19 +0000 (20:53 -0500)
committerMatt McCutchen <matt@mattmccutchen.net>
Thu, 31 Jan 2008 01:53:19 +0000 (20:53 -0500)
README

diff --git a/README b/README
index da0d604..5860522 100644 (file)
--- a/README
+++ b/README
@@ -22,11 +22,13 @@ classes, so big-integer calculations are as easy as:
 The code in `sample.cc' demonstrates the most important features of the library.
 To get started quickly, read the code and explanations in that file and run it.
 If you want more detail or a feature not shown in `sample.cc', consult the
 The code in `sample.cc' demonstrates the most important features of the library.
 To get started quickly, read the code and explanations in that file and run it.
 If you want more detail or a feature not shown in `sample.cc', consult the
-consult the actual header and source files, which are heavily commented.
+consult the actual header and source files, which are thoroughly commented.
 
 
-The code is intended to be reasonably portable across computers and modern C++
-compilers; in particular, it uses whatever word size the computer provides
-(32-bit, 64-bit, or whatever).  Please report any portability problems.
+This library emphasizes ease of use and clarity of implementation over speed;
+some users will prefer GMP (http://swox.com/gmp/), which is faster.  The code is
+intended to be reasonably portable across computers and modern C++ compilers; in
+particular, it uses whatever word size the computer provides (32-bit, 64-bit, or
+otherwise).
 
 Compiling programs that use the library
 ---------------------------------------
 
 Compiling programs that use the library
 ---------------------------------------
@@ -37,24 +39,21 @@ library source files and the sample program and links them together; you can
 easily customize the Makefile to replace the sample with your own program, or
 you can write your own Makefile.
 
 easily customize the Makefile to replace the sample with your own program, or
 you can write your own Makefile.
 
+Resources
+---------
+The library's Web site (above) provides links to released versions, the current
+development version, and a mailing list for release announcements, questions,
+bug reports, and other discussion of the library.  I would be delighted to hear
+from you if you like this library and/or find a good use for it.
+
 Bugs and enhancements
 ---------------------
 The library has been tested by me and others but is by no means bug-free.  If
 Bugs and enhancements
 ---------------------
 The library has been tested by me and others but is by no means bug-free.  If
-you find a bug, please report it to me, whether it comes in the form of
-compiling trouble, a mathematically inaccurate result, or a memory-management
-blooper (since I use Java, these are altogether too common in my C++).  I
-generally fix all reported bugs.
-
-You are also welcome to request enhancements, but I am unlikely to do
-substantial amounts of work on enhancements at this point.  When I fix a bug you
-report or make an enhancement you request, I will generally credit you by name
-in the Change Log unless you request otherwise.  New versions of the library
-will be available at its Web site (above).
-
-Note
-----
-I would be delighted to hear from you if you like this library and/or find a
-good use for it.
+you find a bug, please report it, whether it comes in the form of compiling
+trouble, a mathematically inaccurate result, or a memory-management blooper
+(since I use Java, these are altogether too common in my C++).  I generally fix
+all reported bugs.  You are also welcome to request enhancements, but I am
+unlikely to do substantial amounts of work on enhancements at this point.
 
 Legal
 -----
 
 Legal
 -----