Skip to content

Commit 1bc18e6

Browse files
authored
Update README.md
1 parent e5ef802 commit 1bc18e6

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,19 @@ There are only C and C++ interface headers for now. <br>
3737
3. **MINGW 11.2.0** (tested on this, but might also work with previous versions), you can check if it is already installed in your machine by running <br>
3838

3939
```
40-
$gcc --version
40+
$ gcc --version
4141
```
4242

4343
OR
4444

4545
```
46-
$g++ --version
46+
$ g++ --version
4747
```
4848

4949
If this isn't already installed, run the following in MSYS2 MinGW shell
5050

5151
```
52-
$pacman -S gcc
52+
$ pacman -S gcc
5353
```
5454

5555
4. **GNU Make 4.3**, you can check if it is already installed, though it already comes with mingw64 binutils package, by running
@@ -87,8 +87,8 @@ There are only C and C++ interface headers for now. <br>
8787
```
8888
8. **Vulkan Headers**
8989
```
90-
meson wrap install vulkan-headers
91-
meson wrap install glfw
90+
$ meson wrap install vulkan-headers
91+
$ meson wrap install glfw
9292
```
9393

9494
### Requirements for building on Linux (Debian)
@@ -170,8 +170,8 @@ There are only C and C++ interface headers for now. <br>
170170
```
171171
8. **Vulkan Headers**
172172
```
173-
meson wrap install vulkan-headers
174-
meson wrap install glfw
173+
$ meson wrap install vulkan-headers
174+
$ meson wrap install glfw
175175
```
176176

177177
### Requirements for building on FreeBSD
@@ -181,23 +181,23 @@ For now, you would need to do the following:
181181
- You will need gcc and g++ compilers supporting C++20, FreeBSD uses LLVM/Clang by default
182182
- Install the following packages
183183
```
184-
pkg install gmake # for GNU make
185-
pkg install shaderc # for shaderc libraries and glslc
186-
pkg install pkgconf # for pkg-config
184+
$ pkg install gmake # for GNU make
185+
$ pkg install shaderc # for shaderc libraries and glslc
186+
$ pkg install pkgconf # for pkg-config
187187
```
188188

189189
#### For Building SUTK (Spectrum UI Toolkit library), you will need cmake
190190
##### On Linux
191191
```
192-
apt install cmake
192+
$ apt install cmake
193193
```
194194
##### On Windows (MSYS)
195195
```
196-
pacman -S cmake
196+
$ pacman -S cmake
197197
```
198198
##### On FreeBSD
199199
```
200-
pkg install cmake
200+
$ pkg install cmake
201201
```
202202

203203

@@ -219,7 +219,7 @@ $ make -f build_shaders.makefile all
219219
1. Clone the repository by running the following command <br>
220220

221221
```
222-
$git clone https://github.com/ravi688/VulkanRenderer.git
222+
$ git clone https://github.com/ravi688/VulkanRenderer.git
223223
```
224224

225225
2. Change the working directory to `VulkanRenderer`
@@ -235,11 +235,11 @@ $ make -f build_shaders.makefile all
235235
```
236236
5. Verify Installation by running pkg-config as follows
237237
```
238-
pkg-config sge_static --cflags --libs
238+
$ pkg-config sge_static --cflags --libs
239239
```
240240
OR
241241
```
242-
pkg-config sge_shared --cflags --libs
242+
$ pkg-config sge_shared --cflags --libs
243243
```
244244
It must print include header and link libraries directories which you can pass into your gcc or clang compiler/linker.
245245

@@ -259,12 +259,12 @@ sge_static = sge_static_dep
259259
### Test Run (Optional)
260260
There are several tests which you can try running by just passing arguments:
261261
```
262-
$./build/main_test CUBE
262+
$ ./build/main_test CUBE
263263
```
264264
The above set of commands would launch a window in which a white cube will be spinning.
265265
If you want to see all the possible test cases, you may launch the execution without any arguments and it would just print the list of possible test cases:
266266
```
267-
$./build/main
267+
$ ./build/main
268268
supported tests:
269269
DEPTH_RENDER_TEXTURE
270270
DEPTH_RENDER_TEXTURE_LOAD
@@ -307,7 +307,7 @@ $ meson setup build --wipe
307307
```
308308
### Cleaning Shaders
309309
```
310-
make -f build_shaders.makefile clean
310+
$ make -f build_shaders.makefile clean
311311
```
312312

313313
### Building SUTK (Spectrum UI Toolkit)

0 commit comments

Comments
 (0)