Skip to content

Commit 0c0a805

Browse files
authored
Update README.md
1 parent dd35e5a commit 0c0a805

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Welcome to the Raycasting Engine project, an implementation of a DOOM Style rend
99
This project is developed in a **recreational programming** context, it does not aim to be *production ready* at some point. It serves as a learning experience to explore new concepts and technologies while creating a project around them.
1010

1111
## Goals
12-
The primary goal of this project is to implement a DOOM Style Renderer with a simple Engine around it and a Graphical Editor for prototyping Maps, rendering, gameplay etc... I'm using modern C++ and technologies like raylib and imgui it achieve this goal. At the end the engine should be able to build and ship a standalone executable without prototyping tools.
12+
The primary goal of this project is to implement a DOOM Style Renderer with a simple Engine around it and a Graphical Editor for prototyping Maps, rendering, gameplay etc... I'm using modern C++ and technologies like raylib and imgui it achieve this goal. At the end the engine should be able to build and ship a standalone executable without the editor.
1313

1414
## Showcase
1515

@@ -70,12 +70,12 @@ This repo toolchain as been created using my [cmake and vcpkg template](https://
7070

7171
### Bootstrap workspace
7272

73-
`Windows :`
73+
**Windows :**
7474

7575
Make sure you installed [Visual Studio](https://visualstudio.microsoft.com/) with [C and C++ support](https://learn.microsoft.com/cpp/build/vscpp-step-0-installation?view=msvc-170#step-4---choose-workloads) and [C++ linux development with cmake](https://learn.microsoft.com/cpp/linux/download-install-and-setup-the-linux-development-workload?view=msvc-170#visual-studio-setup).
7676
Make sure you installed [CMake](https://cmake.org/download) as well.
7777

78-
`GNU/Linux (apt) :`
78+
**GNU/Linux (apt) :**
7979

8080
Install necessary build tools and a C/C++ compiler
8181
```sh
@@ -91,7 +91,7 @@ Then run the bootstrap script
9191
.\scripts\bootstrap-workspace.bat
9292
```
9393

94-
*Generate the project :*
94+
**Generate the cmake project :**
9595

9696
```sh
9797
# For debug build
@@ -107,7 +107,7 @@ Then run the bootstrap script
107107
.\scripts\generate-cmake-release.bat
108108
```
109109

110-
*Compile the project :*
110+
**Compile :**
111111

112112
```bash
113113
# For debug build
@@ -124,6 +124,7 @@ Then run the bootstrap script
124124
```
125125

126126
**Run the program**
127+
127128
You can now run the compiled program by looking into `out/Debug` or `out/Release`.
128129
The out directory hierarchy will be different depending on your generator.
129130

0 commit comments

Comments
 (0)