Improve the README with more information and links.

(Also, try to test out the new commit script.)

diff --git a/README b/README
index b0650392ed4d17505a156c89c1af822954de79e0..84c2fdee440803d912f346e54efad74334858c34 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,17 @@
+0. BUILDING AND INSTALLATION (Briefly)
+
+$ ./configure
+$ make
+$ make verify   # (optional)
+$ sudo make install
+
+1. BUILDING AND INSTALLATION (In Depth)
+
 To build libevent, type
 
 $ ./configure && make
 
-     (If you got libevent from the subversion repository, you will
+     (If you got libevent from the git repository, you will
       first need to run the included "autogen.sh" script in order to
       generate the configure script.)
 
@@ -10,7 +19,7 @@ Install as root via
 
 # make install
 
-You can run the regression tests by
+You can run the regression tests by running
 
 $ make verify
 
@@ -18,10 +27,46 @@ Before, reporting any problems, please run the regression tests.
 
 To enable the low-level tracing build the library as:
 
-CFLAGS=-DUSE_DEBUG ./configure [...]
+   CFLAGS=-DUSE_DEBUG ./configure [...]
+
+Standard configure flags should work.  In particular, see:
+
+   --disable-shared          Only build static libraries
+   --prefix                  Install all files relative to this directory.
+
+
+The configure script also supports the following flags:
+
+   --enable-gcc-warnings     Enable extra compiler checking with GCC.
+   --disable-malloc-replacement
+                             Don't let applications replace our memory
+                             management functions
+   --disable-openssl         Disable support for OpenSSL encryption.
+   --disable-thread-support  Don't support multithreaded environments.
+
+2. USEFUL LINKS:
+
+For the latest released version of Libevent, see the official website at
+http://monkey.org/~provos/libevent/ .
+
+There's a pretty good work-in-progress manual up at
+   http://www.wangafu.net/~nickm/libevent-book/ .
+
+For the latest development versions of Libevent, access our Git repository
+via
+   "git clone git://levent.git.sourceforge.net/gitroot/levent/libevent"
+
+You can browse the git repository online at
+http://levent.git.sourceforge.net/git/gitweb-index.cgi .
+
+To report bugs, request features, or submit patches to Libevent,
+use the Sourceforge trackers at
+https://sourceforge.net/tracker/?group_id=50884 .
+
+There's also a libevent-users mailing list for talking about Libevent
+use and development: http://archives.seul.org/libevent/users/
 
-Acknowledgements:
------------------
+3. ACKNOWLEDGMENTS
 
 The following people have helped with suggestions, ideas, code or
 fixing bugs:
@@ -31,6 +76,7 @@ fixing bugs:
   William Ahern
   Stas Bekman
   Andrew Danforth
+  Christopher Davis
   Mike Davis
   Shie Erlich
   Alexander von Gernler