X-Git-Url: https://mattmccutchen.net/bigint/bigint.git/blobdiff_plain/3e1327901d299a537a8d932c49dd330f87ac3bda..7ff315b8c61de6ad089736f6729e689b1ff2a103:/README

diff --git a/README b/README
index da0d604..ae9d3da 100644
--- a/README
+++ b/README
@@ -22,39 +22,45 @@ 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
-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
 ---------------------------------------
 The library consists of a folder full of C++ header files (`.hh') and source
-files (`.cc').  `#include' header files and compile with source files as
-necessary for your own programs.  A Makefile is included that compiles the
-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.
+files (`.cc').  Your own programs should `#include' the necessary header files
+and link with the source files.  A makefile that builds the sample program
+(`sample.cc') is included; you can adapt it to replace the sample with your own
+program.
+
+Alternatively, you can use your own build system or IDE.  In that case, you must
+put the library header files where the compiler will find them and arrange to
+have your program linked with the library source files; otherwise, you will get
+errors about missing header files or "undefined references".  To learn how to do
+this, consult the documentation for the build system or IDE; don't bother asking
+me.  Adding all the library files to your project will work in many IDEs but may
+not be the most desirable approach.
+
+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
-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
 -----