/kinship

Standalone Ruby script that converts object relationships specified in YAML format to DOT format.

Primary LanguageRuby

Kinship

Standalone Ruby script that converts object relationships specified in YAML format to DOT format.

Quickstart

To output a DOT graph text file to STDOUT:

$ ./kinship.rb -i example.yml 

If you have Graphviz installed, you can pipe it and generate an image file:

$ ./kinship.rb -i example.yml | dot -Tpng -o example.png

Installation

TODO

Usage

TODO

Examples

TODO

License

Copyright (c) 2016 Bob Nadler

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.