Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.

Commit

Permalink
Add showcase screenshot, contributors, documentation, and UML class d…
Browse files Browse the repository at this point in the history
…iagram
  • Loading branch information
johannes67890 committed Dec 21, 2023
1 parent e3fde4c commit f98d678
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
# MinituareWorld
A miniature world simulation, with the use of ITU's simulation library.

## Krav fortolkning pr. tema
## Showcase
![ShowcaseScreenshot](./docs/projectReport/screenshot.PNG)

## How to run
1. Clone the repository
``$ git clone https://github.com/johannes67890/MiniatureWorld.git``
2. Open the project
3. Run the `Main` class

## Video demo

## Contributors
- [Johannes Jørgensen](https://github.com/johannes67890)
- [Elias Lildholdt](https://github.com/Spurberino)
- [Frederik Buur](https://github.com/Frededb)

## Documentation
- [Project report](./docs/projectReport/ProjectReport.pdf)
- [Diary](./docs/projectDiary/diary.pdf)

## UML Class diagram
![Class diagram](./docs/projectReport/ClassDiagram.png)

0 comments on commit f98d678

Please sign in to comment.