diff --git a/README.md b/README.md index 2f8e883fd2e2034dbed727d5f5fd229f1d6c2c6c..b7f7d7df146c96aa920e32f0e815eae8f63fda12 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# IDATG1002_2022_group6 +# TrackPong - tournament app +The aim of this project is to create an application that wil be used for creating table tennis tournaments. +This application gets rid of the hassle of keeping track of a table tennis tournament manually. +The reason we wanted to create this application was in accordance to the project assignment. + +##Technologies +The project is created with Java 17. + +##Setup +The application will be wrapped up as a zip-file and includes the executable +.jar file which itself contains everything a computer would need to run the +application. The zip-file also includes the README.md file and the user +manual. The zip-file will be found in the GIT repository. + +##Features +* Create tournaments with either 4, 8, 16 or 32 players. +* Create players for the tournament after choosing format. +* Play a single round friendly match. +* View info about the application. +* View the rules of table tennis on an external website. +* Save a group of players. +* Load a chosen group of players. +