Skip to content

Commit

Permalink
Readme and building docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
serhii-rieznik committed Feb 6, 2022
1 parent f45b740 commit 203bcb6
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,6 @@ Order is a subject to change, but here are main things to do:
This part of the description would be updated during the development of the project, at the moment there is nothing to build here.
All updates will be located here: [BUILDING.md](docs/BUILDING.md)

#### Docs
[Code style](docs/CODESTYLE.md) - code style may confuse you. But there is an explanation for that :)

#### Sponsors
This project is GitHub-sponsored by:
* [Traverse-Research](https://github.com/Traverse-Research)
Expand Down
14 changes: 13 additions & 1 deletion docs/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,23 @@ But this libraries and tools you have to install by yourself:

## Building for Windows
Windows is the only one platform, which is supported at the moment.
- install latest release of Intel Embree from [GitHub](https://github.com/embree/embree/releases)
- download and install the latest release of Intel Embree from [GitHub](https://github.com/embree/embree/releases)
- copy embree binaries (embree3.dll and tbb12.dll) to "bin" folder in the root directory of etx-tracer;
- and then building should be as simple as creating a folder for build files and calling CMake, something like:
```
cmake -G "Visual Studio 17 2022" ..
```

## Built-in dependencies
These libraries are included into the source code in `thirdparty` folder:
- [enkits](https://github.com/dougbinks/enkiTS) - A permissively licensed C and C++ Task Scheduler for creating parallel programs
- [glm](https://github.com/g-truc/glm) - OpenGL Mathematics
- [imgui](https://github.com/ocornut/imgui) - Dear ImGui: Bloat-free Graphical User interface for C++ with minimal dependencies
- [jansson](https://github.com/akheron/jansson) - C library for encoding, decoding and manipulating JSON data
- [mikktspace](https://github.com/mmikk/MikkTSpace) - A common standard for tangent space used in baking tools to produce normal maps.
- [sokol_app, sokol_gfx, sokol_imgui](https://github.com/floooh/sokol) - minimal cross-platform standalone C headers
- [stb_image](https://github.com/nothings/stb) - stb single-file public domain libraries for C/C++
- [tinyexr](https://github.com/syoyo/tinyexr) - Tiny OpenEXR image loader/saver library
- [tinyobjloader](https://github.com/tinyobjloader/tinyobjloader) - Tiny but powerful single file wavefront obj loader


6 changes: 0 additions & 6 deletions docs/CODESTYLE.md

This file was deleted.

0 comments on commit 203bcb6

Please sign in to comment.