Skip to content

Commit

Permalink
Merge pull request #123 from JacobDomagala/117-update-readme
Browse files Browse the repository at this point in the history
[#117]: Update README
  • Loading branch information
JacobDomagala authored Apr 25, 2024
2 parents f93f0a1 + a250fa0 commit 861dc12
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,30 @@ Shady is a 3D rendering engine written in modern C++ and Vulkan. It's not meant

This project is in an early stage so it's still missing many basic features. For current roadmap/planned features see [Github Project](https://github.com/users/JacobDomagala/projects/3/views/1) </br>

Below you can see famous [Sponza](https://en.wikipedia.org/wiki/Sponza_Palace) scene rendered using Shady.
![Sponza](https://github.com/JacobDomagala/Shady/wiki/screenshot_vulkan.PNG)
Below you can see famous [Sponza](https://en.wikipedia.org/wiki/Sponza_Palace) scene rendered using Shady (click to see YouTube video): <br>
[![Sponza](https://github.com/JacobDomagala/Shady/wiki/Youtube.png)](https://www.youtube.com/watch?v=LZlHqkR0CQ0)

------------------------------------------------------------
## Building

Shady is CMake/Conan based project working both on Linux (Ubuntu) and Windows. To build it, you will need at least C++20 compiler and CMake version 3.22. </br>
While most of the dependencies will be handled by Conan/CMake, it's required that you have Vulkan installed on your machine.
While most of the dependencies will be handled by Conan, it's required that you have Vulkan installed on your machine.

Typical build process would look like this:
```bash
# Create build directory
mkdir build && cd build

# Use newer ABI
conan profile new default --detect
conan profile update settings.compiler.libcxx=libstdc++11 default
conan install .. --output-folder=build --build=missing --settings=build_type=Release
conan profile detect
conan install .. -of=build --build=missing -s compiler.cppstd=20

# Generate build system for Windows/Linux
cmake -G "Ninja" ..
cmake -G "Ninja" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake ..

# Build
cmake --build .
```

## Youtube
For past and future video logs, please visit my [Youtube](https://www.youtube.com/@Jacob.Domagala) channel. <br>
[![Playlist](https://img.youtube.com/vi/LZlHqkR0CQ0/0.jpg)](https://www.youtube.com/watch?v=LZlHqkR0CQ0&list=PLRLVUsGGaSH8GcSjxOiAQBRWuFpVtWVOp "YouTube Playlist")

0 comments on commit 861dc12

Please sign in to comment.