$Id: INSTALL.txt,v 1.11 2002/09/26 06:42:28 kingofgib Exp $

LIBPNET6, A Portable Network Libarary
Copyright (c) 2002, Peter Bozarov


Installing
==========

Unzip and untar the distribution to your favorite location, let's say
<some_location>. Then do 

    $ cd <some_location>/libpnet6-XXXX
    (Windows, change slash to backslash)
where XXXX stands for the version of the distribution, e.g. 1.0.2a.

Type 

$ make

Follow the instructions make gives you.

If all goes well, then directory lib will contain the libpnet6 library and
the directory bin will contain a bunch of examples as executables.

You can now type 'make install' to have libpnet6 placed in some convenient
location of your choice. Default for now is /usr/local/include and 
/usr/local/lib. (NOTE: this does not really work yet on all systems)

Examples
========

Go to the tests directory. All examples are here.

Documentation
=============

Yes, we currently got (some) documentation. The directory doc/man holds
the man pages, while doc/html holds the html pages. Of course, one can
always just go to pnet6.sourceforge.net and check the docs there.

Contribution
============

Everyone's welcome to join the team, especially if you have knowledge of 
obscure operating systems to which we can port this, like Mac, SCO,
HP, AIX, OS/390, and more... Go to pnet6.sourceforge.net/contact.html for
details.

Remarks
=======

Currently, this is an experimental release, were releasing this in the 
hope of getting some feedback, which will help us improve LIBPNET6.

Code is not 100% ok, it might crash, and there's bound to be a lot of
bugs.  However, this is a work in progress. I'm releasing new versions
every week, I hope to have a definite, initial 'product' version by
end of September. But we shall see....

Have fun with this one.
