From 6007f52194d595b4d6d7d382a3bb1fcbfdc10955 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 26 Sep 2022 22:41:45 +0200 Subject: [PATCH] README.md: Update with cmake info. --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 61e911d..c79c540 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,37 @@ 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. +This project uses [cmake](https://cmake.org) build system +(Version 3.15 or greater) to compile the engine. -Just running `bam` in this directory will start build the source. +### Linux with make. +``` +$ mkdir build +$ cd build +$ cmake .. -G "Unix Makefiles" +$ make +``` + +### Windows using NMake +``` +$ mkdir build +$ cd build +$ cmake .. -G "NMake Makefiles" +$ nmake +``` + +### Or the best way (in my opinion) +install [Ninja](https://ninja-build.org) and run +``` +$ mkdir build +$ cd build +$ cmake .. -G Ninja +$ ninja +``` 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