The README is used to introduce the module and provide instructions on how to install the module, any machine dependencies it may have (for example C compilers and installed libraries) and any other information that should be provided before the module is installed.
A README file is required for CPAN modules since CPAN extracts the README file from a module distribution so that people browsing the archive can use it get an idea of the modules uses. It is usually a good idea to provide version information here so that people can decide whether fixes for the module are worth downloading.
INSTALLATION
To install this module type the following:
perl Makefile.PL
or if you need to setup module to your own lib catalog use
the INSTALLSITELIB environment variable. For example:
perl Makefile.PL INSTALLSITELIB=~/myperl After Makefile is created run next commands:
make
make test
make install
If you used INSTALLSITELIB then put next string in your script:
use lib "~/myperl";
use CGI::okSession;
to use your own lib location in script.
DEPENDENCIES
This module requires these other modules and libraries:
Storable
Time::HiRes
Digest::MD5
COPYRIGHT AND LICENCE
Copyright (C) 2003 O. A. Kobyakovskiy
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.