Update Readme
This commit is contained in:
parent
8c9c1e0997
commit
1dc0ecf563
1 changed files with 18 additions and 0 deletions
18
README.md
18
README.md
|
|
@ -1,3 +1,21 @@
|
||||||
# Spectre 2D Engine
|
# Spectre 2D Engine
|
||||||
|
|
||||||
A simple 2D Game engine from scratch!
|
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)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue