Compare commits

..

1 Commits

Author SHA1 Message Date
30b16b298d Write README 2025-09-23 15:43:28 +01:00
4 changed files with 8 additions and 19 deletions

1
.gitattributes vendored
View File

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

1
.gitignore vendored
View File

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

View File

@@ -1,10 +1,8 @@
# 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):
This is a simple raytracer, written for POSIX systems in C23 with zero
runtime dependencies (outside of the standard library). To build with
CMake:
```sh
cmake -B build
@@ -12,11 +10,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 +24,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.

BIN
demo.png LFS

Binary file not shown.