-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added package.json; updated readme to have more details.
- Loading branch information
Showing
4 changed files
with
58 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,4 +9,5 @@ out | |
gen | ||
|
||
|
||
test/testModel1Output | ||
test/testModel1Output | ||
copyFiles.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,39 @@ | ||
# StarUMLJS | ||
|
||
JavaScript code generation plugin for StarUML diagramming tool. | ||
|
||
## Current Status | ||
|
||
* Currently supports one way generation of JS code from a UML model. | ||
* Uses the standard prototype JS definition of a "class" | ||
|
||
### Supported UML Concepts | ||
|
||
* The tool currently supports a subset of the StarUML model: | ||
|
||
* Classes | ||
* Methods of classes (all treated as public) | ||
* Attributes of classes | ||
* Class Documentation | ||
* Method Documentation | ||
* Method Specification | ||
* Method Precondition | ||
* Method Postcondition | ||
* Method Parameters | ||
* Dependencies | ||
* Direct Association | ||
* Generalization | ||
|
||
|
||
## Developers | ||
|
||
* Please contribute, this project is by no means complete and is currently not stable. | ||
* Open dev tasks are: | ||
* Reverse code engineering | ||
* Other "class" definition styles | ||
* More advanced UML concept support | ||
|
||
### Useful Links | ||
|
||
* StarUML application page: [http://staruml.io/](http://staruml.io/) | ||
* StarUML extension developer guide: [https://github.com/staruml/staruml-dev-docs/wiki](https://github.com/staruml/staruml-dev-docs/wiki) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"name": "sdiemert.starumljs", | ||
"title": "StarUMLJS", | ||
"description": "JavaScript Code Generation Plugin", | ||
"homepage": "https://github.com/sdiemert/StarUMLJS", | ||
"version": "0.1.0", | ||
"keywords": ["javascript", "staruml", "js", "UML"], | ||
"author": { | ||
"name": "Simon Diemert", | ||
"email": "[email protected]", | ||
"url": "https://github.com/sdiemert" | ||
}, | ||
"license": "MIT", | ||
"engines": { | ||
"staruml": ">=2.0.0" | ||
} | ||
} |