41 lines
721 B
Markdown
41 lines
721 B
Markdown
# Spectre 2D Engine
|
|
|
|
A simple 2D Game engine from scratch!
|
|
|
|
## Compiling
|
|
|
|
This project uses [cmake](https://cmake.org) build system
|
|
(Version 3.15 or greater) to compile the engine.
|
|
|
|
### Linux with make.
|
|
```sh
|
|
$ mkdir build
|
|
$ cd build
|
|
$ cmake .. -G "Unix Makefiles"
|
|
$ make
|
|
```
|
|
|
|
### Windows using NMake
|
|
```sh
|
|
$ mkdir build
|
|
$ cd build
|
|
$ cmake .. -G "NMake Makefiles"
|
|
$ nmake
|
|
```
|
|
|
|
### Or the best way (in my opinion)
|
|
install [Ninja](https://ninja-build.org) and run
|
|
```sh
|
|
$ mkdir build
|
|
$ cd build
|
|
$ cmake .. -G Ninja
|
|
$ ninja
|
|
```
|
|
|
|
The build will produce `spectre.lib` in the `build` directory that
|
|
should be used when linking.
|
|
|
|
|
|
## Author
|
|
|
|
Henrik Hautakoski - [henrik.hautakoski@gmail.com](mailto:henrik.hautakoski@gmail.com)
|