Developer Documentation
This page collects the current documentation available for the Volity system.
Overviews and Quick Starts
Our wiki is the wellspring of documentation for all of Volity's protcols and projects. Some starting points:
Frivolity (Perl) Documentation
Those seeking documentation on the Frivolity Perl modules need look
no further than the modules themselves; they contain embedded docs in
POD format. Use the perldoc command-line program to read
them.
The main module (Volity.pm/perldoc Volity) contains
the index to all the other pieces of Frivolity documentation.
HTML documentation is available under Frivolity's CPAN entry. Start with this page.
Python Volity Documentation
The Volity Python modules also have embedded documentation, in Python's
docstring format. Use the pydoc command-line program to read
them.
You can also view this documentation as HTML pages.
SVG/ECMAScript Documentation
A tutorial on Creating a Volity SVG UI. This walks through the creation of a sample UI for Tic Tac Toe. (You can also look at a slightly different sample UI for Tic Tac Toe, which comes with the Frivolity distribution.)
UI file documentation in the wiki:
