should give quick and dirty guidance
authorswa <swa@users.sourceforge.net>
Thu, 13 Sep 2001 15:24:30 +0000 (15:24 +0000)
committerswa <swa@users.sourceforge.net>
Thu, 13 Sep 2001 15:24:30 +0000 (15:24 +0000)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..dc0281a
--- /dev/null
+++ b/README
@@ -0,0 +1,109 @@
+/*********************************************************************\r
+ *\r
+ * File        :  $Source: /cvsroot/ijbswa/current/config.h.in,v $\r
+ *\r
+ * Purpose     :  README file to give a short intro.\r
+ *\r
+ * Copyright   :  Written by and Copyright (C) 2001 the SourceForge\r
+ *                IJBSWA team.  http://ijbswa.sourceforge.net\r
+ *\r
+ *                Based on the Internet Junkbuster originally written\r
+ *                by and Copyright (C) 1997 Anonymous Coders and \r
+ *                Junkbusters Corporation.  http://www.junkbusters.com\r
+ *\r
+ *                This program is free software; you can redistribute it \r
+ *                and/or modify it under the terms of the GNU General\r
+ *                Public License as published by the Free Software\r
+ *                Foundation; either version 2 of the License, or (at\r
+ *                your option) any later version.\r
+ *\r
+ *                This program is distributed in the hope that it will\r
+ *                be useful, but WITHOUT ANY WARRANTY; without even the\r
+ *                implied warranty of MERCHANTABILITY or FITNESS FOR A\r
+ *                PARTICULAR PURPOSE.  See the GNU General Public\r
+ *                License for more details.\r
+ *\r
+ *                The GNU General Public License should be included with\r
+ *                this file.  If not, you can view it at\r
+ *                http://www.gnu.org/copyleft/gpl.html\r
+ *                or write to the Free Software Foundation, Inc., 59\r
+ *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
+ *\r
+ *********************************************************************/\r
+\f\r
+\r
+This README is included with the development version of Junkbuster,\r
+which will eventually become Junkbuster v3.0. See\r
+http://ijbswa.sourceforge.net.\r
+\r
+Internet Junkbuster is a web proxy with advanced filtering\r
+capabilities for protecting privacy and removing ads, banners, pop-ups\r
+and other obnoxious Internet Junk.\r
+\r
+ INSTALL\r
+--------\r
+\r
+For tarball, first unpack:\r
+\r
+ tar zxvf ijb_source_*\r
+ cd ijb_source_2.9.8_alpha\r
+\r
+ ./configure\r
+ make\r
+ su\r
+ make install\r
+\r
+Redhat and SuSE src and binary RPMs can be built with 'make\r
+redhat-dist' or 'make suse-dist'.\r
+\r
+Junkbuster is also availabe via anonymous CVS:\r
+\r
+ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login\r
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co\r
+current\r
+\r
+This will create a directory named 'current'. Then, 'cd current', and then\r
+build as above.\r
+\r
+ RUN\r
+----\r
+\r
+ junkbuster /etc/junkbuster/config &\r
+\r
+Or for RPMS: /etc/rc.d/init.d/junkbuster start\r
+\r
+CONFIGURATION\r
+-------------\r
+\r
+See: 'config', 'actionsfile', and 're_filterfile'. There are many changes and\r
+advances since v2.0.x. Be sure to set your browsers for HTTP Proxy at\r
+localhost:8000.\r
+\r
+DOCUMENTATION\r
+-------------\r
+\r
+The best source of information on the current development version, is\r
+either comments in the source code, or the included configuration\r
+files, which are all well commented. These are 'config',\r
+'actionsfile', and 're_filterfile' in the toplevel source directory.\r
+\r
+There is a growing amount of new documentation in the 'doc'\r
+subdirectory, but it is sparse at this point. In particular, see the\r
+developer-manual and user-manual there.\r
+\r
+Some legacy documentation is also included only to give an idea of\r
+what Junkbuster can do under doc/obsolete/*. Much has changed since\r
+these docs were written, so beware.\r
+\r
+BUGS\r
+----\r
+\r
+Use the form at\r
+http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to\r
+report bugs. Please read the exising bug reports before submitting\r
+anything new.\r
+\r
+-------------------------------------------------------------------------\r
+ijbswa-developers@lists.sourceforge.net\r
+\r
+$Id$\r