From 3efffb9ca98303487cf091447c7ba3fba3c71df8 Mon Sep 17 00:00:00 2001 From: JP Appel Date: Tue, 30 Apr 2024 06:46:31 -0400 Subject: finishing changes to presentation --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 17c312e..a962c12 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Each version of the complex fractal generator has its own dependencies. The serial version should compile on all systems that support complex arithmetic. The shared version requires a compiler with [OpenMP](https://www.openmp.org/) support. -The CUDA version requires the `nvcc` compiler and `thrust libraries`. +The CUDA version requires the `nvcc` compiler and `thrust` libraries. For better performance on your machine, change the flag `-arch=sm_86` in `NVCFLAGS` in the makefile to your gpu's compute capability. ### Building @@ -68,6 +68,38 @@ Generates a 500x500 julia fractal grid which has a maximum of 30 iterations for ## Visualizations +The program `fractal-render` renders `.grid` files into txt, png's, and animated gifs. + +``` +Usage: fractal-render -i input.grid [-r renderer] [-o output.ext] +Options: + -i, --input the grid to be rendered, if the file name is '-' reads from stdin + -r, --renderer the renderer to use, defaults to the text renderer + renderers: txt, png, gif (TODO, with additional features) + -d, --delay the delay between animation frames in 1/100 s + -o, --output the file to output the result of rendering, if not given defaults to fractal.out. + -v, --verbose verbose output + -h, --help prints this help and exits +``` + +### Building + +To build simply run + +```bash +make +``` + +### Examples + +Some example visualizations are provided in `examples`, they can be regenerated with + +```bash +make examples/julia.png +make examples/multicorn.gif +``` + + ## Presentation Building the presentation requires a [pandoc](https://pandoc.org/) installation. -- cgit v1.2.3