diff options
| author | Mateja <mail@matejamaric.com> | 2021-02-13 14:43:27 +0100 |
|---|---|---|
| committer | Mateja <mail@matejamaric.com> | 2021-02-13 14:43:27 +0100 |
| commit | 0ac8e95ac4f29d38a121260a5800702cb342f50b (patch) | |
| tree | a7363db6c23a4873fc81a2b29e6f350bda147987 /README.md | |
| parent | 2c60e8825c56861cac639e79e5cb74108b947617 (diff) | |
| download | erender-0ac8e95ac4f29d38a121260a5800702cb342f50b.tar.gz erender-0ac8e95ac4f29d38a121260a5800702cb342f50b.zip | |
Update README.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 33 insertions, 1 deletions
@@ -1,4 +1,36 @@ +# About this project: + Inspired by [thebennybox's 3D Software Rendering](https://www.youtube.com/playlist?list=PLEETnX-uPtBUbVOok816vTl1K9vV1GgH5) series but made using C++ and [SFML](https://www.sfml-dev.org/). It also implements the barycentric rendering technique instead of the scanline technique. -To compile this program you need to install `libsfml-dev` package and run `make`. +## How to build (using CMake): + +### On GNU/Linux: + +Since this project is using [SFML](https://www.sfml-dev.org/), you will need following dependencies: + +- freetype +- x11 +- xrandr +- udev +- opengl +- flac +- ogg +- vorbis +- vorbisenc +- vorbisfile +- openal +- pthread + +Then run following commands in project directory: + + mkdir build && cd build + ln -s ../model . # Make example model available + cmake .. + make + +### On Windows and Mac: + +On Windows and Mac you don't have any dependencies, so you can use CMake without any worry. +**Just make sure all submodules are available using `git submodule update --init`!** +**Also make sure `model` directory (where example model is located) is available where you built the executable.** |