Write README

This commit is contained in:
2025-09-23 15:41:58 +01:00
parent e35d1a68a3
commit 9e8a0022dd

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# Batomorph
Batomorph is a simple ray tracer, written in C23 for POSIX systems.
![Demo rendering](demo.png)
To build with CMake (there are no dependencies):
```sh
cmake -B build
cmake --build build
```
You may want to adjust the `NTHREADS` definition in `src/render.c` to
match your system.
The demo programs (`build/demo` and `build/rand`) will write the
rendered image in sRGB
[Farbfeld](https://tools.suckless.org/farbfeld/) to `stdout`:
```sh
build/demo > out.ff # Produce Farbfeld file
build/demo | ff2png > out.png # Produce PNG file
build/demo | feh # View directly
```
(Note that `ff2png` and `feh` are third-party programs)