diff --git a/README.md b/README.md index a6e95dfd459112f96911a51f45e0fdf3d69cd7bb..7aa31032e719a8be68c4a9e24677f9144c7eba36 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,20 @@ # Tournament Service -This is a service tool for setup and result for a multi-team tournament. The application is originally designed for floorball, but can be used any multi-team tournament. (chess, handball, badminton, volleyball, e-sports, Quiz or similar). - +This is a service tool for setup and result for a multi-team tournament. The application is originally designed for floorball, but can be used any multi-team tournament. It is created for the course IDATT1002 by Carl Gützkow, Nicolai Brand, Callum Gran, Runar Indahl, Eiliert Hansen and Brage Kvamme. More information about the project can be found in the [wiki](https://gitlab.stud.idi.ntnu.no/carljgu/tournament-service/-/wikis/home). # Installation Guide -This installation guide will teach you how to install and run this Tournament Service. To be able to run and install it properly, you will need to have the following programs installed on you computer. - -## Java Development Kit -Java Development Kit (JDK) is needed to run this program. You will at least need version 1.7 or higher to run this program. To install JDK, you can go to the [JDK download page](https://www.oracle.com/java/technologies/downloads/#jdk18-windows). Here you will need to download and install the suitable JDK for you operating system. - -## Git -You will need Git to be able to clone the repository to your own computer. [Here is the download page for Git](https://git-scm.com/downloads). - -## Maven -Maven is a build tool used for dependencies in Java. This means that you have to install maven on your computer to run the Tournament Service program. - -[Maven download page](https://maven.apache.org/download.cgi) - -[Installation guide](https://maven.apache.org/install.html) - -## SSH key -A SSH is needed to clone the repository. Here are tutorials on how to set up a SSH key on you GitLab profile. This tutorial also contains a Git tutorial. - +To install the program, go to [the installtion manual](https://gitlab.stud.idi.ntnu.no/carljgu/tournament-service/-/wikis/System/Installation-manual) -[MacOS tutorial](https://medium.com/devops-with-valentine/2021-how-to-setup-your-ssh-key-for-gitlab-on-macos-dfccec6904fb#:~:text=Copy%20the%20entire%20contents%20of,and%20finally%20click%20Add%20key) -[Windows tutorial](https://medium.com/devops-with-valentine/2021-how-to-your-ssh-key-for-gitlab-on-windows-10-587579192be0) +# Clone and run the repository +You will need git and Maven to be able to clone and run the program on your own computer. -## Cloning the repository -After downloading all the required software above, you can now begin this step. +To clone the repository type: -Create a folder where you want to install the Tournament Service. Then you must open the folder in the terminal. When you have opened the folder in the terminal, you must write these two commands in order: +`$ git clone https://gitlab.stud.idi.ntnu.no/carljgu/tournament-service` -`mvn clean install` +Once cloned, type: -`mvn javafx:run` +`$ cd tournament-service && mvn javafx:run ` -After writing `mvn javafx:run`, the program should open. +to run the program.