Permalink
Browse files

MINOR: Add readme

  • Loading branch information...
1 parent f2b5915 commit 32ab3301d884bbf4862c7e922b649c5f285b7dd1 @mateusz mateusz committed Apr 17, 2012
Showing with 18 additions and 0 deletions.
  1. +18 −0 README.md
View
@@ -0,0 +1,18 @@
+## Overview
+
+Codeviz module provides some code insight based on file parsing and model inspection.
+
+It has been pulled out of the core in SilverStripe 3.0 and is provided as is.
+
+## Installation
+
+Drop the module to codeviz.
+For model graphs [Graphviz](http://graphviz.org/) is required.
+
+## Usage
+
+Just visit one of the following:
+
+ <webroot>/ModelViewer
+ <webroot>/CodeViewer
+ <webroot>/TestViewer

0 comments on commit 32ab330

Please sign in to comment.