Repository navigation
forked from theunrepentantgeek/NAntGraph
Folders and files
Repository files navigation
~~~~~~~~~~~~~~~~~~ What is NAntGraph? ~~~~~~~~~~~~~~~~~~ NAntGraph is a documentation tool designed to make it easier to understand NAnt or Ant build files. A common proverb reads A picture is worth a thousand words. In the computer field, we often find that one diagram is worth a thousand lines of code - or more. In fact, a good diagram can make it much easier to understand the code - providing an easy entry point through which a reader may gain a high level understanding before approaching the code itself. Based on GraphViz, NAntGraph depicts the structure of your build file targets and their dependencies as a directed graph. For the latest version of NAntGraph, see http://www.nichesoftware.co.nz/content/nantgraph ~~~~~~~~~~~~~~~~~~~ System Requirements ~~~~~~~~~~~~~~~~~~~ Runtime ~~~~~~~ To run NAntGraph you will need the following installed: o .NET Runtime 3.5 o GraphViz If you don't already have this installed, download the latest version from http://www.graphviz.org/Download_windows.php Building ~~~~~~~~ To modify NAntGraph or to compile your own version, you'll need Visual Studio 2008 (or higher) as well as NAnt 0.85 or higher. ~~~~~~~~~ Licensing ~~~~~~~~~ NAntGraph itself is licensed under the GPL v3. Note that the GPL does not apply to the output generated by NAntGraph - you are free to use NAntGraph to generate documentation for commercial projects without being influenced by the GPL. For more information on the GPL v3, see http://www.gnu.org/copyleft/gpl.html