Write README
This commit is contained in:
32
README.md
Normal file
32
README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Batomorph
|
||||
|
||||
Batomorph is a simple ray tracer, written in C23 for POSIX systems.
|
||||
|
||||

|
||||
|
||||
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)
|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user