From bfdeccdc883ad5265b13eb17918686c4331cbc41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Autin?= Date: Sat, 26 Jun 2021 00:46:24 +0000 Subject: [PATCH] Update INSTALL.md --- INSTALL.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 88a9dd5..d12f85d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,7 +1,22 @@ # How to install Boulevard Combattant? +## Windows + 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. +## Linux + +You will need to build the project, as creating a working .jar has proven more difficult than expected. You need `openjdk8`, not `openjdk8-headless`, installed on your computer. + +## MacOS + +We do not provide support for MacOS. It may work though... Try to build it! + # 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. +In order to ensure proper building of the project, clone this repository using your favourite IDE and run the `Main` class. +This project is managed via Maven. All dependencies are automatically downloaded as required. + +## Packaging + +To package, 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`.