Minor updates to reflect status of 3.1.x.
[privoxy.git] / doc / source / readme.sgml
index 46cf428..410b95c 100644 (file)
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.17 2002/06/03 00:28:17 hal9 Exp $
+ $Id: readme.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $
 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
 
  ========================================================================
  NOTE: Please read developer-manual/documentation.html before touching 
- anything in this, or other Privoxy documentation. 
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license 
+ to live a peaceful existence!
  ========================================================================
 
  ===================================================================
  to avoid extra blank lines, etc. 
  ======================================================================
 
+ For stable releases, change 
+  entity % p-not-stable "INCLUDE" 
+ to 
+  entity % p-not-stable "IGNORE" 
+  
+ in the DTD at the top. This will toggle various text 'off'. BOTH
+ MUST be toggled in this case or you will get both text referencing 
+ stable and unstable versions. You only want one or the other!
+
 -->
 <article id="index">
 <artheader>
@@ -68,7 +82,7 @@
  *
  * Purpose     :  README file to give a short intro.
  *
- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001,2002 the SourceForge
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
 <para>
  <!-- include some conditional text -->
  This README is included with <![%p-not-stable;[ the development version of]]>
- Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.2]]><![%p-beta;[ (and soon we hope!)]]>. 
- See http://www.privoxy.org/ for more information. The current code
- level is &p-status;<![%p-beta;[, but seems stable to us :)]]><![%p-alpha;[,
- and may break in mysterious ways :) There may be features only partially 
- implemented, or worse, not functional]]>. 
- </para>
+ Privoxy &p-version;<![%p-not-stable;[, which will someday become Privoxy
+ v3.2]]>. See http://www.privoxy.org/ for more information. The current code
+ level is technically &p-status;<![%p-not-stable;[, but is not yet
+ significantly different from the 3.0.0 stable branch at this time.]]>.
+</para>
 </abstract>
 </artheader>
 
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
+<para>
+ 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.
+</para>
 <para>
  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
 <para>
  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
  whatever you specify in the config file under 'listen-address'. DEFAULT is
- localhost:8118.
+ localhost: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.
 </para>
 <para>
  The actions list can be configured via the web interface accessed via
 <sect1 id="documentation"><title>DOCUMENTATION</title>
 <para>
  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
may not be in sync with current code]]>. In particular, see the User Manual there,
is not completed at this point]]>. In particular, see the User Manual there,
  the FAQ, and those interested in Privoxy development, should look at
  developer-manual. 
 </para>
 <para>
  <![%p-not-stable;[
  The most up to date source of information on the current development version,
- may  be either comments in the source code, or the included
+ may still be either comments in the source code, or the included
  configuration files. ]]>The source and configuration files are all well
  commented. The main configuration files are: 'config', 'default.action', and
  'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>. 
 </para>
 
 <para>
- 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.
 </para>
 </sect1>
 
 <!-- </LiteralLayout> -->
 <!-- </para> -->
 <!-- <para> -->
-<!--  $Id: readme.sgml,v 1.17 2002/06/03 00:28:17 hal9 Exp $ -->
+<!--  $Id: readme.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $ -->
 <!-- </para> -->
 
 </article>