chore: update README with coding guidelines, and a short description
This commit is contained in:
@@ -1,3 +1,28 @@
|
||||
# Silent FH
|
||||
|
||||
Lorem ipsum for now.
|
||||
In Silent FH, you play as a student trapped overnight in the FH Joanneum. During the night the professors turn into monsters and hunt down the trapped students.
|
||||
Your goal is to survive.
|
||||
|
||||
This project uses uv and PyGame as its main libraries.
|
||||
|
||||
To get uv, please see here: https://docs.astral.sh/uv/getting-started/installation/
|
||||
|
||||
To sync the dependencies, please run:
|
||||
|
||||
```
|
||||
uv sync
|
||||
source .venv/bin/activate or source .venv/bin/activate.fish
|
||||
uv run main.py
|
||||
```
|
||||
|
||||
Coding Guidelines:
|
||||
|
||||
- Using branches for features, named like so: feat/feature-name
|
||||
- Using pull requests and merging for code review
|
||||
- Using semantic commits for a good overview of the changes, for example:
|
||||
- feat(component): added new component
|
||||
- fix(bug): fixed a bug
|
||||
- docs(readme): updated documentation
|
||||
- chore(ci): automated build and deployment
|
||||
|
||||
Game coded up by Baumgartner Kevin, Kammerhofer Lukas, Berger Lena and Haiden Niklas.
|
||||
Reference in New Issue
Block a user