Merge pull request #186 from Open-MBEE/release/4.3.0

Release/4.3.0

README.md

@@ -1,3 +1,52 @@
-# MagicDraw Model Development Kit (MDK)
+# Cameo Model Development Kit (MDK)
 
-[ ![Download](https://api.bintray.com/packages/openmbee/maven/mdk/images/download.svg) ](https://bintray.com/openmbee/maven/mdk/_latestVersion)[![CircleCI](https://circleci.com/gh/Open-MBEE/mdk.svg?style=svg)](https://circleci.com/gh/Open-MBEE/mdk)
+[![Download](https://api.bintray.com/packages/openmbee/maven/mdk/images/download.svg)](https://bintray.com/openmbee/maven/mdk/_latestVersion) [![Jira](https://img.shields.io/badge/issues-jira-blue)](https://openmbee.atlassian.net/browse/MDK) [![CircleCI](https://circleci.com/gh/Open-MBEE/mdk.svg?style=shield)](https://circleci.com/gh/Open-MBEE/mdk) [![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/Open-MBEE/mdk.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Open-MBEE/mdk/context:java)
+
+Cameo MDK is a plugin for [Cameo Systems Modeler](https://www.nomagic.com/products/cameo-systems-modeler) and other No Magic environment bundles that’s primary purposes are to sync models with the [MMS](https://github.com/Open-MBEE/mms-alfresco) and implement the [DocGen](src/main/dist/manual) language, which allows modelers to dynamically generate documents in a model-based approach using the view and viewpoint concept.
+
+# Quickstart
+
+## Prerequisites
+
+* [Cameo Systems Modeler (CSM)](https://www.nomagic.com/products/cameo-systems-modeler) or another No Magic environment bundle that includes the [SysML plugin](https://www.nomagic.com/product-addons/magicdraw-addons/sysml-plugin)
+    * The latest Cameo MDK is tested with and supports **19.0 SP3**. Compatibility for previous versions of Cameo MDK can be found in the [compatibility matrices](https://github.com/Open-MBEE/open-mbee.github.io/wiki/Compatibilities).
+* [Model Management System (MMS) 3](https://github.com/Open-MBEE/mms-alfresco)
+
+## Installation
+
+1. [Download](https://bintray.com/openmbee/maven/mdk/_latestVersion) the Cameo MDK plugin, e.g. `mdk-*-plugin.zip`.
+
+2. Run CSM. From the main menu, select "Help" > "Resource/Plugin Manager".
+   ![Resource/Plugin Manager](doc/images/resource-plugin-manager.png)
+
+3. Click "Import", navigate to the downloaded Cameo MDK plugin, and click "Open".
+
+4. CSM should confirm installation with the following prompt.
+
+   ![MDK Installation Confirmation](doc/images/mdk-installation-confirmation.png)
+
+5. Restart CSM. To check installation, select from the main menu "Help" > "Resource/Plugin Manager" > "Plugins (no cost)" and ensure a row exists for "Model Development Kit" and its status is "Installed" with the correct version.
+  ![MDK Installed](doc/images/mdk-installed.png)
+
+> Cameo MDK can also be installed headlessly by simply unzipping the plugin archive into the directory that CSM is installed in.
+  
+## Usage
+
+Documentation can be accessed [online](src/main/dist/manual) or offline in CSM from the main menu "Help" > "Other Documentation" > "MDK [...] UserGuide".
+
+# Contributing
+
+To learn how you can get involved in a variety of ways, please see [Contibuting to OpenMBEE](https://www.openmbee.org/contribute).
+
+# Local Development
+
+Cameo MDK is a Java project that uses the [Gradle](https://gradle.org/) build tool. It can be imported as a Gradle project in IDEs like [IntelliJ](https://www.jetbrains.com/idea/) and [Eclipse](https://www.eclipse.org/ide/).
+
+## Common Tasks
+* `./gradlew dependencies` will download all necessary dependencies.
+* `./gradlew assemble` will compile Cameo MDK from source.
+* `./gradlew distZip` will package the installable plugin.
+* `./gradlew installDist` will install the plugin in a staging environment.
+* `./gradlew runJava` will interactively run CSM with Cameo MDK from the staging environment.
+
+Task dependencies are declared such that all necessary prerequisites are executed/cached, e.g. `runJava` will first `dependencies`, `assemble`, `distZip`, etc.

build.gradle

@@ -143,7 +143,7 @@ dependencies {
     // Other dependencies we're unable to resolve via standard repositories
 
     if (buildAccess == 'internal') {
-        preCompile group: 'gov.nasa.jpl.cae.nomagic', name: 'cae-cameo-systems-modeler-core', version: '4.2.1', classifier: 'linux', ext: 'zip'
+        preCompile group: 'gov.nasa.jpl.cae.nomagic', name: 'cae-cameo-systems-modeler-core', version: '4.3.0', classifier: 'linux', ext: 'zip'
     }
     else {
         preCompile group: 'com.nomagic', name: 'demomagicdraw', version: '190sp3', classifier: 'MagicDraw_Demo_190_sp3_no_install', ext: 'zip'

gradle.properties

@@ -1,4 +1,4 @@
-version=4.2.2
+version=4.3.0
 group=org.openmbee.magicdraw.mdk
 descriptorFile=MDR_Plugin_Model_Development_Kit_91110_descriptor.xml
 magicdDrawGroupName=gov.nasa.jpl.cae.magicdraw.mdk