| 1 |
GPS version 0.01 |
| 2 |
================ |
| 3 |
|
| 4 |
The README is used to introduce the module and provide instructions on |
| 5 |
how to install the module, any machine dependencies it may have (for |
| 6 |
example C compilers and installed libraries) and any other information |
| 7 |
that should be provided before the module is installed. |
| 8 |
|
| 9 |
A README file is required for CPAN modules since CPAN extracts the |
| 10 |
README file from a module distribution so that people browsing the |
| 11 |
archive can use it get an idea of the modules uses. It is usually a |
| 12 |
good idea to provide version information here so that people can |
| 13 |
decide whether fixes for the module are worth downloading. |
| 14 |
|
| 15 |
INSTALLATION |
| 16 |
|
| 17 |
To install this module type the following: |
| 18 |
|
| 19 |
perl Makefile.PL |
| 20 |
make |
| 21 |
make test |
| 22 |
make install |
| 23 |
|
| 24 |
DEPENDENCIES |
| 25 |
|
| 26 |
This module requires these other modules and libraries: |
| 27 |
|
| 28 |
blah blah blah |
| 29 |
|
| 30 |
COPYRIGHT AND LICENCE |
| 31 |
|
| 32 |
Put the correct copyright and licence information here. |
| 33 |
|
| 34 |
Copyright (C) 2002 root |
| 35 |
|
| 36 |
This library is free software; you can redistribute it and/or modify |
| 37 |
it under the same terms as Perl itself. |
| 38 |
|
