diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..88a9dd5 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,7 @@ +# How to install Boulevard Combattant? + +To run Boulevard Combattant, simply get the [latest release](https://gitlab.istic.univ-rennes1.fr/fautin/jeu-de-combat/-/releases) and run the executable JAR. You need Java >8 installed on your computer. All libraries are packaged within the JAR. + +# How to build Boulevard Combattant? + +This project is managed via Maven. To build, simply clone the project, and run `mvn package` in the root directory of the cloned project. A JAR will be generated in `${project_folder}/target`. This project can also be imported in your prefered IDE. To run the game, run the Main class located in the default package.