Maven project

.gitignore

@@ -13,3 +13,20 @@ target/
 #*.class
 #bin/
 *.DS_Store
+
+# Eclipse
+.classpath
+.project
+.settings/
+
+# Maven
+log/
+target/
+classes/
+repo/
+
+# Visual Studio Code
+.vscode/
+/bin/
+
+ontouml-vp-plugin.zip

README.md

@@ -0,0 +1,41 @@
+# OntoUML Plugin for Visual Paradigm
+
+This project contains a [Visual Paradigm](https://www.visual-paradigm.com/) plugin that enables the development of OntoUML models.
+
+This project is defined under the umbrella of the [OntoUML Server](https://github.com/OntoUML/ontouml-server) project and is currently a proof of concept.
+
+If you are interested to know more, feel free to open an issue to provide feedback on the project or reach our team members for more specific cases:
+* [Claudenir M. Fonseca](https://github.com/claudenirmf)
+* [Tiago Prince Sales](https://github.com/tgoprince)
+
+## Installation Instructions
+
+To install the **OntoUML Plugin for Visual Paradigm**, please go to our [releases page](https://github.com/OntoUML/ontouml-vp-plugin/releases).
+
+## Development Instructions
+
+Requirements:
+* [Visual Paradigm](https://www.visual-paradigm.com/)
+* [Maven](https://maven.apache.org/)
+* Java 8 or later
+
+Build instructions:
+* Clone this project within Visual Paradigm's `plugins` folder, typically:
+	* `~/.config/VisualParadigm/plugins/` in **Linux**
+	* `C:\Users\<YOUR_USER_NAME>\AppData\Roaming\VisualParadigm\plugins\` in **Windows**
+	* `~/Library/Application Support/VisualParadigm/plugins/` in **macOS**
+
+```git clone https://github.com/OntoUML/ontouml-vp-plugin.git```
+
+* To import necessary Visual Paradigm dependencies, run the `initialization` command passing the path to your Visual Paradigm installation `VISUAL_PARADIGM_PATH`
+	* `VISUAL_PARADIGM_PATH` in **macOS** is typically `/Applications/Visual\ Paradigm.app/Contents/Resources/app/`
+
+```mvn initialize -Dvisualparadigm.app.dir=VISUAL_PARADIGM_PATH```
+
+* To compile your source, run
+
+```mvn compile -Dvisualparadigm.app.dir=VISUAL_PARADIGM_PATH```
+
+* To generate an ZIP plugin installation, run
+
+```mvn package -Dvisualparadigm.app.dir=VISUAL_PARADIGM_PATH```

assembly.xml

@@ -0,0 +1,26 @@
+<assembly
+	xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
+	<id>zip</id>
+	<formats>
+		<format>zip</format>
+	</formats>
+	<includeBaseDirectory>false</includeBaseDirectory>
+	<fileSets>
+		<fileSet>
+			<directory>${project.basedir}/classes</directory>
+			<outputDirectory>./</outputDirectory>
+		</fileSet>
+		<fileSet>
+			<directory>${project.basedir}/icons</directory>
+			<outputDirectory>./icons/</outputDirectory>
+		</fileSet>
+	</fileSets>
+	<files>
+		<file>
+			<source>${project.basedir}/plugin.xml</source>
+			<outputDirectory>./</outputDirectory>
+		</file>
+	</files>
+</assembly>