Compare commits

...

3 Commits

Author SHA1 Message Date
979a25ed7e Add demo image to README 2025-09-23 15:47:40 +01:00
cd0b96cc0e Add demo image 2025-09-23 15:46:13 +01:00
30b16b298d Write README 2025-09-23 15:43:28 +01:00
4 changed files with 34 additions and 0 deletions

1
.gitattributes vendored Normal file
View File

@@ -0,0 +1 @@
demo.png filter=lfs diff=lfs merge=lfs -text

1
.gitignore vendored
View File

@@ -1,3 +1,4 @@
build/
*.ff
*.png
!demo.png

29
README.md Normal file
View File

@@ -0,0 +1,29 @@
# Batomorph
Batomorph is a simple ray tracer, written for POSIX systems in C23
with no runtime dependencies (outside of the standard library).
![Demo rendering](demo.png)
To build with CMake:
```sh
cmake -B build
cmake --build build
```
You may want to adjust the `NTHREADS` definition in `src/render.c` to
match your system for best performance.
When ran, the demo programs (`build/demo` and `build/rand`) will write
the rendered image in sRGB
[Farbfeld](https://tools.suckless.org/farbfeld/) to standard out. For
example:
```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)

BIN
demo.png LFS Normal file

Binary file not shown.