From 801306ea4100d39b1578e9df6cc77c85a24a0ffb Mon Sep 17 00:00:00 2001 From: Sam Minnee Date: Wed, 5 Sep 2012 18:50:25 +1200 Subject: [PATCH] Added a basic README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2ccaf19 --- /dev/null +++ b/README.md @@ -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.