Skip to content

Commit

Permalink
<Documentation>[]: <Provide minimal documentation>
Browse files Browse the repository at this point in the history
[Probably just understandable by me]

[]
  • Loading branch information
Humberto Sanchez II committed Jul 12, 2022
1 parent f95f300 commit dd73b67
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@

[![Build Status](https://travis-ci.com/hasii2011/PyUt.svg?branch=master)](https://travis-ci.com/hasii2011/PyUt)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[![macOS](https://svgshare.com/i/ZjP.svg)](https://svgshare.com/i/ZjP.svg)
<img width="34" height="17" src="./src/org/pyut/resources/img/gplv3-with-text-136x68.png"/>

[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)

I need a good project description
This project is intended to be used by [Pyut Plugin](https://github.com/hasii2011/pyutplugincore) developers to convert [Pyut](https://github.com/hasii2011/PyUt) XML files to the [Ogl Model](https://github.com/hasii2011/ogl) classes. These model classes can then be used by the Pyut UI to display as UML Diagrams.

------

Use as follows:

```python
untangler: UnTangler = UnTangler(fqFileName='MultiDocumentProject.xml')


document: Document = untangler.documents['Diagram-1']
oglClasses: UntangledOglClasses = document.oglClasses
oglLinks: UntangledOglLinks = document.oglLinks

```



The following is the UML diagram for the Pyut Untangler



------

Expand Down
Binary file added docs/UntanglePyut.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/UntanglePyut.put
Binary file not shown.

0 comments on commit dd73b67

Please sign in to comment.