Add build instructions to README and make the build process update submodules in the initialisation phase

This commit is contained in:
Alexander Söderberg 2020-09-12 17:26:58 +02:00
parent cb1a6ee709
commit 990b5685af
3 changed files with 43 additions and 0 deletions

View file

@ -44,6 +44,16 @@ Once the core functionality is present, the framework will offer implementation
- Discord: https://discord.gg/KxkjDVg
## develop & 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 & builds the project.
Feel free to use this if you want to.
## maven
cloud is available from [IntellectualSites](https://intellectualsites.com)' maven repository:

6
build.sh Executable file
View file

@ -0,0 +1,6 @@
#!/bin/bash
# Make sure all submodules are initialized
git submodule update --remote
# Package all jars
mvn clean package

27
pom.xml
View file

@ -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>