From 2be3830274b9ed9a6e8e4febd4b93de0103cb47a Mon Sep 17 00:00:00 2001 From: Jacob Domagala Date: Mon, 6 Jun 2022 15:33:16 +0200 Subject: [PATCH] [#2]: Update README --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d36680c8..6b4bda2a 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,22 @@ ![Windows](https://github.com/JacobDomagala/DGame/workflows/Windows%20Full%20Build/badge.svg) ![Ubuntu](https://github.com/JacobDomagala/DGame/workflows/Ubuntu%20Full%20Build/badge.svg) -# DGame +# Looper +2D Top-down shooter game (and level editor) written in modern C++. -# Build -**To build this project CMake version 3.5 is required!** +## Build + +Looper is CMake based project working both on Linux (Ubuntu) and Windows. To build it, you will need at least C++17 compiler and CMake version 3.18.
-**Windows:** -- create build folder -- inside build folder run cmake command, i.e. -> cmake -G "Visual Studio 15 2017 Win64" .. -- this command will generate Visual Studio solution file for x64 arch +Typical build process would look like this: +```bash +# Create build directory +mkdir build && cd build +# Generate build system for Windows/Linux +cmake -G "Visual Studio 16 2019" .. +cmake -G "Ninja" .. -# TODO -- Linux compatibility -- Improve enemy AI -- New assets -- Multiplayer -- Sound -- Menu +# Build +cmake --build . +``` \ No newline at end of file