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