From 1dc0ecf563089715ee905e37184f79e15693569d Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Thu, 2 Jan 2020 05:06:05 +0100 Subject: [PATCH] Update Readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 2534839..61e911d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # Spectre 2D Engine A simple 2D Game engine from scratch! + +## Compiling + +This project uses [bam](http://matricks.github.io/bam/) build system +(Version 0.5 or greater) to compile the engine. + +Just running `bam` in this directory will start build the source. + +The build will produce `spectre.lib` in the `build` directory that +should be used when linking. + +You will also need to link against `FreeType2` that is located in +`vendor/FreeType2/lib/x<86|64>/freetype-s.lib` (or `freetype-d-s.lib` +for debug version) + +## Author + +Henrik Hautakoski - [henrik.hautakoski@gmail.com](mailto:henrik.hautakoski@gmail.com)