deb-murano/contrib/utils/uml-generator/README.md
Dmitry Teselkin 2bd4afb2bf UML Generator script
This script builds UML graphs taking Murano DSL manifests as input.

It is able to build the following graphs:
* single class inheritance tree
* class inheritance tree with all resources,
  required by that and other classes

Change-Id: Iac40f4524809e6637662c8db450816d57e7065f1
2014-03-31 20:48:46 +04:00

29 lines
647 B
Markdown

# MuranoPL UML Generator
This folder contains scripts (currently only one) to generate UML graphs based on MuranoPL manifests.
## Installation
1. Copy **umlgen.py** to **meta** folder under MuranoPL directory.
2. Download **plantuml.jar** from http://plantuml.sourceforge.net/ and copy it to the folder ablve.
3. Generate UML graph using the command below:
```
./umlgen.py
```
## Usage
```
./umlgen.py [--no-namespaces] [--parents-only] [CLASS_FQDN]
```
* **--no-namespaces** - disables automatic classes grouping
* **--parents-only** - generate graph using only parent-child dependencies
* **CLASS_FQDN** - MuranoPL class FQDN