grunt-graphviz/README.md

Compile DOT files

# grunt-graphviz

> Compile DOT files

## Dependencies

* Graphviz

### Install

Linux Gentoo
```shell
emerge -av media-gfx/graphviz
```

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-graphviz --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-graphviz');
```

## The "graphviz" task

### Overview
In your project's Gruntfile, add a section named `graphviz` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  graphviz: {
    your_target: {
      files: {
        'dest/file.png': 'source/file.dot',
        // etc...
      }
    },
  },
})
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).