From a43ab40a75e9d4c6ee3fbdd583bc93574db19124 Mon Sep 17 00:00:00 2001 From: Julian T Date: Sun, 7 Feb 2021 00:50:40 +0100 Subject: Add readme --- readme.md | 57 +++++++++++++++++---------------------------------------- 1 file changed, 17 insertions(+), 40 deletions(-) diff --git a/readme.md b/readme.md index 2e46ea9..b535d79 100644 --- a/readme.md +++ b/readme.md @@ -1,48 +1,25 @@ -# Pathtracing +# Rendering in rust -Second attempt at a renderer, written in C++ instead of C to compare languages. -This is also my first big project in C++. +This is a (not finished) ray tracer written in rust. +It is based on the book serie [Ray Tracing In One Weekend](https://raytracing.github.io/) and [Physics Based Rendering](http://www.pbr-book.org/). -My first attempt can be seen here [github](https://github.com/jbjjbjjbj/raytrace) and here [cgit](https://git.jtle.dk/raytrace/about/). +This rust version is my third implementation, the previous being: -## Preview -![render](https://git.jtle.dk/pathtrace/plain/generated.png?h=rendered) - -## Build requirements - -- Catch2 -- Qt5 - -## Building - -This is just standard cmake building. - -``` -mkdir build -cd build -cmake ../ -make -``` +- [Raytracing in c](https://git.jtle.dk/raytrace/about/) + This is the one which gives the best results, + however as my ambitions for the project grew as did my requirement for more language features. +- [Pathtracing in rust](https://git.jtle.dk/pathtrace/about/) +I never really finished it before changing to rust. + However it had a really cool qt gui, updating as samples were added. -The program does currently not have any options, so just run it. +## Rendered image -``` -./pathtracing -``` - - -## Testing - -To test the program follow the steps above but instead of `make` run `make test`. - -``` -make test -``` +![render](https://git.jtle.dk/pathtrace/plain/generated.png?h=rendered) -Then run the test executable. -Remember to rerun `make test` when changing source files. +## Goals -``` -./run_test -``` +- [ ] Render [Cornell box](https://en.wikipedia.org/wiki/Cornell_box) +- [ ] Render collection of circles outside, with blurry background +- [ ] Render [Utah teapot](https://en.wikipedia.org/wiki/Utah_teapot) +- [ ] Render [Stanford dragon](https://en.wikipedia.org/wiki/Stanford_dragon) -- cgit v1.2.3