feat(cli): doc how to run with a 'simple' package (#28)

process-analytics · May 4, 2020 · 4277772 · 4277772
1 parent 86aec92
commit 4277772
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 4 deletions.
diff --git a/java/README.md b/java/README.md
@@ -10,3 +10,18 @@ The project bundles a Maven Wrapper, so just run
 ``` bash
 ./mvnw package
 ```
+
+## Run
+Once you have build the project, run
+```
+java -jar target/bpmn-layout-generator-*-jar-with-dependencies.jar <path_to_input_bpmn_file> <path_to_output_file> [report_type]
+```
+where
+- `<path_to_input_bpmn_file>`: path to the BPMN file
+- `<path_to_output_file>`: path to the file that will store the result of the generation. Notice that the parent folders
+will be created by the tool if they don't exist.
+- `<export_type>`: optional, the export type.
+    - available types: `ascii`, `svg` or `bpmn`. Defaults to `bpmn`.
+    - `ascii` and `svg` have been developed to get feedback when running tests i.e. to get a quick preview of the
+     algorithm result. They are not fully implemented and won't probably never be (if you have some interest on that
+     topic, feel free to provide a Pull Request)
diff --git a/java/pom.xml b/java/pom.xml
@@ -59,25 +59,29 @@
         <pluginManagement>
             <plugins>
                 <!-- Maven Standard Plugins: lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
+                <plugin>
+                    <artifactId>maven-assembly-plugin</artifactId>
+                    <version>3.2.0</version>
+                </plugin>
                 <plugin>
                     <artifactId>maven-clean-plugin</artifactId>
                     <version>3.1.0</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-resources-plugin</artifactId>
-                    <version>3.0.2</version>
+                    <version>3.1.0</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-compiler-plugin</artifactId>
-                    <version>3.8.0</version>
+                    <version>3.8.1</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-surefire-plugin</artifactId>
-                    <version>2.22.1</version>
+                    <version>2.22.2</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-jar-plugin</artifactId>
-                    <version>3.0.2</version>
+                    <version>3.2.0</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-install-plugin</artifactId>
@@ -90,6 +94,28 @@
             </plugins>
         </pluginManagement>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                        <configuration>
+                            <archive>
+                                <manifest>
+                                    <mainClass>io.process.analytics.tools.bpmn.generator.App</mainClass>
+                                </manifest>
+                            </archive>
+                            <descriptorRefs>
+                                <descriptorRef>jar-with-dependencies</descriptorRef>
+                            </descriptorRefs>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>jaxb2-maven-plugin</artifactId>