silverstripe-docsviewer/README.md
2013-03-29 09:38:02 +01:00

25 lines
752 B
Markdown
Executable File

# Documentation Viewer Module
[![Build Status](https://secure.travis-ci.org/silverstripe/silverstripe-docsviewer.png?branch=master)](http://travis-ci.org/silverstripe/silverstripe-docsviewer)
## Maintainer Contact
* Will Rossiter (Nickname: willr, wrossiter)
<will@fullscreen.io>
## Requirements
* SilverStripe 3.0
## Summary
Reads text files from a given list of folders from your installation and
provides a web interface for viewing.
To read documentation go to yoursite.com/dev/docs/
For more documentation on how to use the module please read /docs/Writing-Documentation.md
(or via this in /dev/docs/sapphiredocs/Writing-Documentation in your webbrowser)
**Note** This module assumes you are using numeric values for your versions.