34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
Introduction {#mainpage}
|
|
============
|
|
|
|
This is a library of perl modules intended to simplify the process of creating
|
|
perl-based web applications. It should be noted that this is not the most
|
|
comprehensive, advanced, or even efficient framework for developing perl web
|
|
applications - many other disparate modules exist and can be used together for
|
|
the same ends. However, the modules provided here emphasise simplicity of use,
|
|
flexibility, and clarity, and allow the construction of fairly powerful
|
|
applications for relatively little effort.
|
|
|
|
Issue tracking is done via the Flyspray installation at
|
|
|
|
<http://flyspray.starforge.co.uk/index.php?project=8&do=index>
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Full documentation for this library can be generated using Doxygen v1.8 or
|
|
later (v1.7 will not handle the Markdown content correctly). In order to
|
|
process the perl files correctly, you must install the Doxygen Perl Filter,
|
|
see:
|
|
|
|
* <http://sourceforge.net/projects/perldoxygen/files/>
|
|
* <http://www.bigsister.ch/doxygenfilter/documentation.html>
|
|
|
|
Once you have Doxygen and Doxygen Perl Filter installed, run the 'makedocs.sh'
|
|
script in the main directory to generate the documentation.
|
|
|
|
Why Doxygen instead of POD? Mainly personal preference: I find documentation
|
|
written using doxygen formatting and markup vastly easier to write, and much
|
|
easier to read, than POD documentation. Doxygen also provides better output
|
|
than most POD tools. But if you disagree, there's a 'fork' button on github...
|