Logo

cli photorealistic image generator

CI Coverage Version License
Prerequisites · Installation · Usage

Installation

Prerequisites

Platform requirements

Build requirements

Install cargo stable latest build system, \ for devel it's advisable to install the entire (stable latest) toolchain using rustup

devel: llvm-tools-preview additional component is required for unit tests coverage and \ it's advisable to install cargo-llvm-cov for easily use LLVM source-based code coverage

From binary

Install from binary (you can ignore Build requirements):

bash $ rustracer="rustracer-$version-$platform" $ curl -sJSOL "https://github.com/andros21/rustracer/releases/download/$version/$rustracer.tgz" $ tar -xvf "$rustracer.tgz" $ install -Dm755 "$rustracer/bin/rustracer" "$PREFIX/bin/rustracer"

From source

Install from source code:

bash $ cargo install --locked \ --root "$PREFIX" \ --tag "$version" \ --git "https://github.com/andros21/rustracer" rustracer

Usage

Run rustracer -h for short help or rustracer --help for long help

Example of rustracer convert subcommand:

bash $ rustracer convert image.pfm image.ff # convert to farbfeld $ rustracer convert image.pfm image.png # convert to png

Example of rustracer demo subcommand:

bash $ rustracer demo image.png # render demo scene (hard-coded)

Example of rustrcer render subcommand: bash $ rustracer render scene.yml image.png # render scene descripted in file