Skip to content

Commit

Permalink
Software documentation and proper Readme.md (#3)
Browse files Browse the repository at this point in the history
Documentation for the software and a proper Readme.md file has been added.
  • Loading branch information
IkerGalardi authored Aug 27, 2021
1 parent 6376206 commit 1494898
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# PBR-Renderer
Sinple PBR renderer for learning purposes.
Sinple PBR renderer for learning purposes.

![image](doc/res/tiles_render.png)

## Features
* Physically based Rendering with Cook-Torrance BRDF
* Normal Mapping

## Build instructions
If you want to simply build and test the project type the next command and that should be it!
``` bash
make
./bin/pbr
```
If you want to modify the code, if no more source files are created the before method would work fine. If not, project files need to be recreated, and for that the tool [premake](https://premake.github.io/) is used, specifically the fifth version. To recreate project files and rebuild
```bash
premake5 gmake2
make clean && make
./bin/pbr
```

## Known issues
* Nvidia users, im sorry! For reasons I don't really know, GLEW (the OpenGL loader) does not find any OpenGL version on the system.

## References
* Great shout-out to the pages [learnopengl](https://learnopengl.com/) and [opengl-tutorial](http://www.opengl-tutorial.org/) for the great PBR theory and OpenGL tutorials.
Binary file added doc/SoftwareDocumention.pdf
Binary file not shown.
Binary file added doc/res/tiles_render.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1494898

Please sign in to comment.