diff --git a/README.md b/README.md index 8c854e6..45090ee 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # CacheUMLExplorer -An UML Class explorer for InterSystems Caché. +An UML Class explorer for InterSystems Caché. It can build UML class diagram for any class in Caché. + +## Screenshots + +![2015-04-21_214058](https://cloud.githubusercontent.com/assets/4989256/7260103/6c1e2a20-e870-11e4-8bf0-9832885be9ab.png) + +## Installation + +###### Import classes to Caché +To install Caché UML class explorer, download the [latest release](https://github.com/ZitRos/CacheUMLExplorer/releases) or build project by yourself. Then import XML file inside Cache directory of archive or directory. + +###### Set up WEB application +When you have imported and compiled UMLExplorer package in Caché, make sure the namespace is the same you have imported classes to. Then go to system management portal -> administering -> security -> applications -> web applications and create there a new web application. Fill the name field of it with /UMLExplorer (slash is required) and set the value of dispatch class to UMLExplorer.Router. Click save. Now your WEB application is ready. + +###### Use it +Visit [server domain and port]/UMLExplorer/ (with slash at end) to enter application. + +## Build + +To build project, you need [NodeJS](https://nodejs.org) platform to be installed. Then, clone source code and run npm install from the root of the project. This will install all necessary modules from NPM. Also run npm install -g gulp if you have no gulp builder in your modules. + +After that and each next time just run gulp command from the project root. This will generate build directory, where you will found all what you need.