******************************************************************
                      SWIFTSURF README file
******************************************************************

******************
Table of content :

- Requirement
- Compiling
- Installing
- Running
- Configuring
- Supported platforms
- Contact

*************
Requirement :

Swiftsurf needs an OCaml compiler (>= 3.00) properly installed if you
want to compile it, and gmake if you want to install it.

****************************************************
Compiling (not possible with the compiled version) :

gmake (try "gmake byte" if make does not work)

************
Installing :

gmake install (you have to be root)

*********
Running :

swiftsurf

You also have to tell your browser to use swiftsurf. With Netscape or
Mozilla, see Edit->Preferences->Advanced->Proxy, and set localhost
port 8080 as proxy for http and https.

*************
Configuring :

see swiftsurf.conf (/etc/swiftsurf.conf if you did gmake install) and
the documentation in the doc directory in html format.

*********************
Supported platforms :

SwiftSurf is supposed to work on every Unix platform on which OCaml is
correctly installed. It has been developed under Linux, but works
undoubtedly on any Unix machine.

Please report success or failure on any architecture.

If you want to send me a binary build for your architecture, please
use build_tgz.sh.

*********
Contact :

mailto:sebastien@ailleret.com
http://www.ailleret.com/
