Strengthen the advice about build/IDE configuration in the README.
authorMatt McCutchen <matt@mattmccutchen.net>
Fri, 30 Apr 2010 21:33:52 +0000 (17:33 -0400)
committerMatt McCutchen <matt@mattmccutchen.net>
Fri, 30 Apr 2010 21:33:52 +0000 (17:33 -0400)
I'm sick and tired of questions about link errors because the user's
program is not being linked with the library.  Hopefully the new text
will clue people in.

ChangeLog
README

index 31501f8..4cd0293 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -6,6 +6,10 @@ roughly corresponds to the release date of that version in `YYYY.MM.DD[.N]'
 format, where `.N' goes `.2', `.3', etc. if there are multiple versions on the
 same day.  The topmost version listed is the one you have.
 
+Unreleased
+----------
+- Strengthen the advice about build/IDE configuration in the README.
+
 2009.05.03
 ----------
 - BigUnsigned::{get,set}Bit: Change two remaining `1 <<' to `Blk(1) <<' to work
diff --git a/README b/README
index 862ec50..ae9d3da 100644 (file)
--- a/README
+++ b/README
@@ -33,15 +33,18 @@ 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 use
-your own Makefile or IDE.
+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.
 
-NOTE: It is generally useless to ask me how to set up the library in your IDE
-because you know more about the IDE than I do (unless it's the Eclipse CDT
-<http://www.eclipse.org/cdt/>).
+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
 ---------