cdo/batomorph
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: cdo:979a25ed7e3f9d58ebc1e6ed8b034c6b020786af
Branches Tags
cdo:main
..
compare: cdo:main
Branches Tags
cdo:main

2 Commits
979a25ed7e ... main

Author SHA1 Message Date
Camden Dixie O'Brien
3c04d674a5 Write README 2025-09-23 15:57:02 +01:00
Camden Dixie O'Brien
e35d1a68a3 Add demo image 2025-09-23 15:51:30 +01:00
1 changed files with 11 additions and 8 deletions
Expand all files Collapse all files

19
README.md
View File

@@ -1,11 +1,10 @@
# Batomorph # Batomorph
Batomorph is a simple ray tracer, written for POSIX systems in C23 Batomorph is a simple ray tracer, written in C23 for POSIX systems.
with no runtime dependencies (outside of the standard library).
![Demo rendering](demo.png) ![Demo rendering](demo.png)
To build with CMake: To build with CMake (there are no dependencies):
```sh ```sh
cmake -B build cmake -B build
@@ -13,12 +12,11 @@ cmake --build build
``` ```
You may want to adjust the `NTHREADS` definition in `src/render.c` to You may want to adjust the `NTHREADS` definition in `src/render.c` to
match your system for best performance. match your system.
When ran, the demo programs (`build/demo` and `build/rand`) will write The demo programs (`build/demo` and `build/rand`) will write the
the rendered image in sRGB rendered image in sRGB
[Farbfeld](https://tools.suckless.org/farbfeld/) to standard out. For [Farbfeld](https://tools.suckless.org/farbfeld/) to `stdout`:
example:
```sh ```sh
build/demo > out.ff # Produce Farbfeld file build/demo > out.ff # Produce Farbfeld file
@@ -27,3 +25,8 @@ build/demo | feh # View directly
``` ```
(Note that `ff2png` and `feh` are third-party programs) (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.