From 990b5685af1699c53cbb3d15b2f265861d11310e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexander=20S=C3=B6derberg?= <sauilitired@gmail.com>
Date: Sat, 12 Sep 2020 17:26:58 +0200
Subject: [PATCH] Add build instructions to README and make the build process
 update submodules in the initialisation phase

---
 README.md | 10 ++++++++++
 build.sh  |  6 ++++++
 pom.xml   | 27 +++++++++++++++++++++++++++
 3 files changed, 43 insertions(+)
 create mode 100755 build.sh

diff --git a/README.md b/README.md
index 83d8f48a..d240ec0f 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,16 @@ Once the core functionality is present, the framework will offer implementation
 
 - Discord: https://discord.gg/KxkjDVg
 
+## develop &amp; build
+
+To clone the repository, use `git clone --recursive https://github.com/Sauilitired/cloud.git`.
+To then build it, use `mvn clean package`. If you've already cloned the repository without
+doing it recursively, use `git submodule update --remote` to update the submodule. This is
+only needed the first time, as Maven will perform this operation when building. 
+
+There is a bash script (`build.sh`) that performs the submodule updating &amp; builds the project.
+Feel free to use this if you want to.
+
 ## maven
 
 cloud is available from [IntellectualSites](https://intellectualsites.com)' maven repository:
diff --git a/build.sh b/build.sh
new file mode 100755
index 00000000..6a272a17
--- /dev/null
+++ b/build.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# Make sure all submodules are initialized
+git submodule update --remote
+# Package all jars
+mvn clean package
diff --git a/pom.xml b/pom.xml
index 93bac2aa..1a946e8f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -48,6 +48,30 @@
             </resource>
         </resources>
         <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>3.0.0</version>
+                <inherited>false</inherited> <!-- only execute these in the parent -->
+                <executions>
+                    <execution>
+                        <id>git submodule update</id>
+                        <phase>initialize</phase>
+                        <configuration>
+                            <executable>git</executable>
+                            <arguments>
+                                <argument>submodule</argument>
+                                <argument>update</argument>
+                                <argument>--init</argument>
+                                <argument>--recursive</argument>
+                            </arguments>
+                        </configuration>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
@@ -57,6 +81,9 @@
                 </configuration>
                 <executions>
                     <execution>
+                        <phase>
+                            initialize
+                        </phase>
                         <goals>
                             <goal>check</goal>
                         </goals>