Create an appropriate readme file
We should create a readme.md file in the root of this repository. This file should include:
- Link to the Google Drive folder (peers-only)
- Link to the actual version of the Game Design Document (located in the root folder, can be peer-only)
- Link to the Figma UI mock-up (can be peers-only)
- Link to the actual entity-relationship UML diagram (can be peer-only)
- Link to the current Unity version the project uses
- Link to download JetBrains Rider
- Description of the Git workflow as it was described for Assignment 3
- Above should include the link to Conventional commits
- Conventional commits section should describe used commit labels, mention that domain is optional:
-
feature(domain)
- you've something new, added a feature -
fix(domain)
- you fixed an issue or a mistake -
chore(domain)
- dependency updates, refactoring and cleanup (direct translation of the word "chore" is "рутина")
-