diff options
| author | Sakarias Johansson <sakarias.johansson@goodbyekansas.com> | 2023-01-19 19:43:17 +0100 |
|---|---|---|
| committer | Sakarias Johansson <sakariasjohansson@hotmail.com> | 2023-01-19 20:10:00 +0100 |
| commit | b24f6d9bc9cf1f72c0fb85eb8b25e051b81b7b4f (patch) | |
| tree | fb01fd99732b40cce549275da686c469d749d563 /README.md | |
| parent | 2abf48d9ce2968f7e999a9e0faf6d0ebfa752c7c (diff) | |
| download | racer-tracer-b24f6d9bc9cf1f72c0fb85eb8b25e051b81b7b4f.tar.gz racer-tracer-b24f6d9bc9cf1f72c0fb85eb8b25e051b81b7b4f.tar.xz racer-tracer-b24f6d9bc9cf1f72c0fb85eb8b25e051b81b7b4f.zip | |
📖 Add README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
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. + + + +# 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. + |