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

View File

@@ -1,10 +1,11 @@
# Batomorph
Batomorph is a simple ray tracer, written in C23 for POSIX systems.
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 (there are no dependencies):
To build with CMake:
```sh
cmake -B build
@@ -12,11 +13,12 @@ cmake --build build
```
You may want to adjust the `NTHREADS` definition in `src/render.c` to
match your system.
match your system for best performance.
The demo programs (`build/demo` and `build/rand`) will write the
rendered image in sRGB
[Farbfeld](https://tools.suckless.org/farbfeld/) to `stdout`:
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
@@ -25,8 +27,3 @@ build/demo | feh # View directly
```
(Note that `ff2png` and `feh` are third-party programs)
## License
Batomorph is Copyright © Camden Dixie O'Brien, and is available under
the Komorebi 2.0.0 license. See [LICENSE.md](LICENSE.md) for details.