Create README.md

This commit is contained in:
Anonymus Raccoon
2020-05-03 16:36:14 +02:00
committed by GitHub
parent c13ff04eec
commit d29d82d69f

10
README.md Normal file
View File

@@ -0,0 +1,10 @@
# Twac
A simple 2D platformer made using Gamacon.
## Building
To build this project, you will first need to clone it with the recursive option ``git clone --recurse git@github.com:AnonymusRaccoon/ForecastingVillage.git``. This will clone the game engine and it's dependencies with this project.
After cloning the repository, you can simply use the makefile and run ``make``.
## Libraries
This project has been made using [Gamacon](https://github.com/AnonymusRaccoon/Gamacon) an ECS C-Modular game engine and the [CSFML](https://www.sfml-dev.org/download/csfml/).