Merge branch 'table-of-contents' into 'main'

Add table of contents, frontend

See merge request !99

README.md

@@ -13,3 +13,10 @@ A description of the backend modules, functions and classes is found [here](/bac
 The frontend is written in Java using the LibGDX framework. The frontend handles the game logic, rendering and user interaction.
 
 A description of the frontend modules and classes is found [here](/frontend/README.md).
+
+### Diagrams
+
+In the diagrams you will find class diagrams for both frontend and backend. 
+
+- [frontend](/diagrams/frontend)
+- [backend](/diagrams/backend)

backend/README.md

@@ -45,6 +45,8 @@ The backend will only allow 30 requests per minute from the same IP address. Thi
 # Backend repository structure
 Under follows a listing of the files in the backend/src directory, each file with a short description.
 
+[[_TOC_]]
+
 ## controllers
 Controller part of the MVC pattern. Each file contains a collection of functions that process the requests coming in through the endpoints in the Routes module, and returns a response.
 

frontend/README.md

@@ -5,11 +5,14 @@ It is written in Java an utilizes the Libgdx-framework.
 The Box2D-framework is used as the 2D-physics-engine. 
 Scene2D is used to display menu graphics and game HUD.
 
+
 ## How to run the frontend
 The frontend can be run in two ways:
 - Open an Android emulator, for instance in Android Studio, and install the `android-tankWars.apk` file on the emulator. In Android Studio the installation can be done by pulling the .apk file over the emulator and dropping it.
 - Clone the repository from Gitlab, and open the `/frontend/build.gradle` file in Android studio. Click the green run button on the top of the IDE to run the code on the emulator.
 
+[[_TOC_]]
+
 ## Frontend repository structure
 
 The frontend repo is structured into models, views and controllers, with the exception of a few helper classes.