Skip to content

Commit

Permalink
[#2]: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobDomagala committed Jun 6, 2022
1 parent 7ce0f39 commit 2be3830
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. </br>

**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 .
```

0 comments on commit 2be3830

Please sign in to comment.