first crude attempt .. doesn't handle failed upgrades yet
[debian/sudo] / README
diff --git a/README b/README
index 225fb5a53716f8ac0fce00866c563f1d03eca272..919c74a6565d97e06382a0e45a97ac4d34e99c08 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,3 @@
-This is Sudo version 1.6.8
-
 The sudo philosophy
 ===================
 Sudo is a program designed to allow a sysadmin to give limited root privileges
@@ -9,8 +7,10 @@ privileges as possible but still allow people to get their work done.
 Where to find sudo
 ==================
 Before you try and build sudo, *please* make sure you have the current
-version.  The latest sudo may always be gotten via anonymous ftp
-from ftp.sudo.ws in the directory /pub/sudo/.
+version.  The latest sudo may always be gotten via anonymous ftp from
+ftp.sudo.ws in the directory /pub/sudo/ or from the sudo web site,
+http://www.sudo.ws/
+
 The distribution is sudo-M.m.tar.gz where `M' is the major
 version number and `m' is the minor version number.
 BETA versions of sudo may also be available.  If you join
@@ -19,25 +19,22 @@ the `sudo-workers' mailing list you will get the BETA announcements
 
 What's new
 ==========
-For a history of sudo please see the HISTORY file that came with this
-release.
-
-For a complete list of changes, see the CHANGES file.  For a summary,
-see the web page, http://www.sudo.ws/sudo/.
+See the NEWS file for a list of major changes in this release.
+For a complete list of changes, see the ChangeLog file.  For a
+summary of major changes to the current stable release, see the web
+page, http://www.sudo.ws/sudo/stable.html.
 
 If you are upgrading from an earlier version of Sudo, please see
-the UPGRADE file.
+the UPGRADE file in the doc directory.
 
-NOTE: Starting with sudo 1.5.7 the configuration method has changed
-      significantly as compared to previous versions.  All options
-      are now set via the configure script.  See the `INSTALL' file
-      for a list of all the configure options.
+For a history of sudo please see the HISTORY file in the doc directory.
 
 System requirements
 ===================
-To build sudo from the source distribution you need a machine running
-UN*X (most flavors of BSD, SYSV, or POSIX will do), a working C
-compiler, and the make utility.
+To build sudo from the source distribution you need a nominally
+POSIX-compliant operating system (any modern version of BSD, Linux
+or UNIX should work), a working ANSI/ISO C compiler (C89 or higher),
+and the ar, make and ranlib utilities
 
 If you wish to modify the parser then you will need flex version
 2.5.2 or later and either bison or byacc (sudo comes with a pre-flex'd
@@ -51,15 +48,12 @@ mirror.
 Building the release
 ====================
 Please read the installation guide in the `INSTALL' file before
-trying to build sudo.  The `RUNSON' file contains a list of of
-platforms that this version of sudo is known to work on.  If you
-can add to this list, please send mail to sudo@sudo.ws.  If
-something goes wrong you may want to refer to the `TROUBLESHOOTING'
-file.
+trying to build sudo.  Pay special attention to the "OS dependent notes"
+section.
 
 Copyright
 =========
-Sudo is distributed under a BSD-style license.
+Sudo is distributed under an ISC-style license.
 Please refer to the `LICENSE' file included with the release for details.
 
 Mailing lists
@@ -74,6 +68,10 @@ sudo-users   This list is for questions and general discussion about sudo.
 sudo-workers   This list is for people working on and porting sudo.
                http://www.sudo.ws/mailman/listinfo/sudo-workers
 
+sudo-commits   This list receives a message for each commit made to
+               the sudo source repository.
+               http://www.sudo.ws/mailman/listinfo/sudo-commits
+
 To subscribe to a list, visit its url (as listed above) and enter
 your email address to subscribe.  Digest versions are available but
 these are fairly low traffic lists so the digest versions are not
@@ -84,17 +82,16 @@ for the appropriate links.
 
 Web page
 ========
-There is a sudo `web page' at http://www.sudo.ws/sudo/
-that contains an overview of sudo as well as pointers to BETA versions
-and other useful info.
+There is a sudo web page at http://www.sudo.ws/ that contains
+an overview of sudo, documentation, downloads, information about
+beta versions and other useful info.
 
 Bug reports
 ===========
-A list of known bugs may be found in the `BUGS' file.  If you have
-found what you believe to be a bug, you can file a bug report with
-the sudo bug database, on at web at http://www.sudo.ws/bugs/.
+If you have found what you believe to be a bug, you can file a bug
+report in the sudo bug database, on the web at http://www.sudo.ws/bugs/.
 
-Please read over the `TROUBLESHOOTING' file *before* submitting a
-bug report.  When reporting bugs, please be sure to include the
-version of sudo you are using as well as the platform you are running
+Please read over the `TROUBLESHOOTING' file in the doc directory *before*
+submitting a bug report.  When reporting bugs, please be sure to include
+the version of sudo you are using as well as the platform you are running
 it on.