Added documentation for new --chroot option
[privoxy.git] / README
diff --git a/README b/README
index 575cbab..83bcd74 100644 (file)
--- a/README
+++ b/README
  *
  *********************************************************************/
 
-This README is included with the development version of Privoxy 2.9.15, which
-will eventually become Privoxy v3.0 (and soon we hope!). See http://
-www.privoxy.org/ for more information. The current code level is beta, and
-seems stable to us :).
 
 -------------------------------------------------------------------------------
 
+     **********************************************************
+     
+ NOTE: This is a pre-release version of Privoxy from the "stable" CVS branch.
+ It is being readied for the next stable release -- 3.0.1 which could happen
+ "soon". While this tree is in a transition state, the version will be
+ intentionally stamped as "0.0.0" so as to make it clear that this code is not
+ yet ready for release. If you try this code, and find problems which seem to
+ be bugs, please report it to the developers list.
+
+     **********************************************************
+
 Privoxy is a web proxy with advanced filtering capabilities for protecting
 privacy, filtering web page content, managing cookies, controlling access, and
 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
@@ -51,6 +58,10 @@ Privoxy is based on Internet Junkbuster (tm).
 
 1. IMPORTANT CHANGES
 
+REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version of
+Privoxy 3.0 is finally released! This is way behind schedule, but better late
+than never. The developers all hope the wait was worth it.
+
 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
 Junkbuster to Privoxy. This is reflected in many of the included files.
 
@@ -65,48 +76,8 @@ change your browser if upgrading!!! And maybe firewall, etc.
 
 2. INSTALL
 
-To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
-compiler like gcc are required.
-
-When building from a source tarball (either release version or nightly CVS
-tarball), first unpack the source:
-
- tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz]                           
- cd privoxy-2.9.15-beta                                                        
-
-For retrieving the current CVS sources, you'll need CVS installed. Note that
-sources from CVS are development quality, and may not be stable, or well
-tested. To download CVS source:
-
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current 
-  cd current                                                                         
-
-This will create a directory named current/, which will contain the source
-tree.
-
-Then, in either case, to build from unpacked tarball or CVS source:
-
- autoheader                                                                    
- autoconf                                                                      
- ./configure      # (--help to see options)                                    
- make             # (the make from gnu, gmake for *BSD)                        
- su                                                                            
- make -n install  # (to see where all the files will go)                       
- make install     # (to really install)                                        
-
-If you have gnu make, you can have the first four steps automatically done for
-you by just typing:
-
-  make                                                                         
-
-in the freshly downloaded or unpacked source directory.
-
-For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
-self-extracting installers, building on platforms with special requirements
-etc, please consult the developer manual.
-
-For binary RPM installation, and other platforms, see the user-manual as well.
+See the INSTALL file in this directory, for installing from source, and the
+User Manual, for other installation types.
 
 -------------------------------------------------------------------------------
 
@@ -143,7 +114,7 @@ options, and examples: http://www.privoxy.org/user-manual/.
 
 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 you specify in the config file under 'listen-address'. DEFAULT is localhost:
-8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it 
+8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 with FTP or other protocols for the simple reason it does not work.
 
 The actions list can be configured via the web interface accessed via http://
@@ -166,7 +137,9 @@ files. The source and configuration files are all well commented. The main
 configuration files are: 'config', 'default.action', and 'default.filter' in
 the toplevel source directory.
 
-Included documentation may vary according to platform and packager.
+Included documentation may vary according to platform and packager. All
+documentation is posted on http://www.privoxy.org, in case you don't have it,
+or can't find it.
 
 -------------------------------------------------------------------------------
 
@@ -227,7 +200,7 @@ troubled site and even pre-fill the form!
 
 New, improved default.action files will occasionally be made available based on
 your feedback. These will be announced on the ijbswa-announce list and
-available from our project page.
+available from our the files section of our project page.
 
 -------------------------------------------------------------------------------