-Apache/MVC version 0.01
-=======================
+NAME
+ Maypole - MVC web application framework
-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.
+DESCRIPTION
+ Maypole is a Perl framework for MVC-oriented web applications, similar
+ to Jakarta's Struts or Ruby on Rails. Maypole is designed to minimize
+ coding requirements for creating simple web interfaces to databases,
+ while remaining flexible enough to support enterprise web applications.
-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.
+QUICK START
+ Maypole ships with a basic demo application, the Beer Database.
+ Please see the Maypole manual. You can access the manual by executing the
+ following command after installing Maypole:
-INSTALLATION
+ perldoc Maypole::Manual
-To install this module type the following:
+ Or try the following URL:
- perl Makefile.PL
- make
- make test
- make install
+ http://search.cpan.org/perldoc?Maypole::Manual
-DEPENDENCIES
+SUPPORT
+ Maypole is supported by a community of users on the Maypole mailing lists.
-This module requires these other modules and libraries:
+ Join the mailing list at:
- blah blah blah
+ http://lists.sourceforge.net/lists/listinfo/maypole-users
-COPYRIGHT AND LICENCE
+LINKS
+ http://maypole.perl.org - Maypole's home. tips & tricks, mailing list
-Put the correct copyright and licence information here.
+AUTHOR
+ Maypole is currently maintained by Aaron Trevena, C<aaron.trevena#gmail.com>
-Copyright (C) 2004 Simon Cozens
+AUTHOR EMERITUS
+ Simon Cozens, C<simon#cpan.org>
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+LICENSE
+ You may distribute this code under the same terms as Perl itself.