Added a basic README

This commit is contained in:
Sam Minnee 2012-09-05 18:50:25 +12:00
parent 129695b268
commit 801306ea41

17
README.md Normal file
View File

@ -0,0 +1,17 @@
doc.silverstripe.org
====================
This is the source code powering http://doc.silverstripe.org. It primarily consists of:
* SilverStripe
* The [docsviewer](https://github.com/silverstripe/silverstripe-docsviewer) module
Development and contribution
----------------------------
To set up a test instance:
* Clone this repository to a LAMP server.
* Run "make" to check out the repositories from which is builds the docs (this will take a while the first time)
To contribute an improvement, submit a pull request on GitHub. Any approved pull requests will make their way onto the doc.silverstripe.org site in the next release.