Skip to content

Commit 2be3830

Browse files
committed
[#2]: Update README
1 parent 7ce0f39 commit 2be3830

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
![Windows](https://github.com/JacobDomagala/DGame/workflows/Windows%20Full%20Build/badge.svg)
33
![Ubuntu](https://github.com/JacobDomagala/DGame/workflows/Ubuntu%20Full%20Build/badge.svg)
44

5-
# DGame
5+
# Looper
6+
2D Top-down shooter game (and level editor) written in modern C++.
67

7-
# Build
8-
**To build this project CMake version 3.5 is required!**
8+
## Build
9+
10+
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>
911

10-
**Windows:**
11-
- create build folder
12-
- inside build folder run cmake command, i.e.
13-
> cmake -G "Visual Studio 15 2017 Win64" ..
14-
- this command will generate Visual Studio solution file for x64 arch
12+
Typical build process would look like this:
13+
```bash
14+
# Create build directory
15+
mkdir build && cd build
1516

17+
# Generate build system for Windows/Linux
18+
cmake -G "Visual Studio 16 2019" ..
19+
cmake -G "Ninja" ..
1620

17-
# TODO
18-
- Linux compatibility
19-
- Improve enemy AI
20-
- New assets
21-
- Multiplayer
22-
- Sound
23-
- Menu
21+
# Build
22+
cmake --build .
23+
```

0 commit comments

Comments
 (0)