From b24f6d9bc9cf1f72c0fb85eb8b25e051b81b7b4f Mon Sep 17 00:00:00 2001 From: Sakarias Johansson Date: Thu, 19 Jan 2023 19:43:17 +0100 Subject: =?UTF-8?q?=F0=9F=93=96=20Add=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ assets/trace_sample.png | Bin 0 -> 627562 bytes 2 files changed, 38 insertions(+) create mode 100644 README.md create mode 100644 assets/trace_sample.png diff --git a/README.md b/README.md new file mode 100644 index 0000000..b716c16 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Racer Tracer + +A simple ray tracer written in rust. A hobby project for now. Feedback +and contributions are still very welcome. + +![sample](./assets/trace_sample.png) + +# Building + + +## Using nix +`nix-shell default.nix` +After that you can do `cargo build`, `cargo run --release` etc. + + +## Not using nix +Currently uses rust version 1.65.0(may work on lower versions). + +On Linux you may need to install these dependencies for the `minifb` +crate to work. + +`sudo apt install libxkbcommon-dev libwayland-cursor0 libwayland-dev` + + +# Running +The application accepts the following arguments. +`--config` path to the config file. +`--scene` path to the scene file. + +Just running it without any arguments will use the default config and +scene provided by this repository. Once the application starts it will +present a crude preview image of the scene. + + +## Controls +`WASD` Moves the camera in a currently crude way. +`R` Starts rendering the image. + diff --git a/assets/trace_sample.png b/assets/trace_sample.png new file mode 100644 index 0000000..bb07aae Binary files /dev/null and b/assets/trace_sample.png differ -- cgit v1.2.3