From d29d82d69fb89c6d490a405dbc5a29d36fe604e5 Mon Sep 17 00:00:00 2001 From: Anonymus Raccoon Date: Sun, 3 May 2020 16:36:14 +0200 Subject: [PATCH] Create README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f16f0cd --- /dev/null +++ b/README.md @@ -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/).