diff options
| author | JP Appel <jeanpierre.appel01@gmail.com> | 2024-04-25 19:38:57 -0400 |
|---|---|---|
| committer | JP Appel <jeanpierre.appel01@gmail.com> | 2024-04-25 19:39:21 -0400 |
| commit | 8279af3c8b3916f27067d004e9c6130d03f8359e (patch) | |
| tree | 1ac611f438f392d3c8ba7a3f6d97ca1c9723e156 /README.md | |
| parent | f15d4cdb413d2fe28ff20cfccb784cf739aad8e6 (diff) | |
updated readme with grid generator usage
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -17,9 +17,36 @@ To build all versions simply run make ``` +If you wish to compile with additional floating point precision, add `-DEXTENDED_PRECISION` to `CPPFLAGS` in the makefile. + +**NOTE:** extended precision is **NOT** supported in the cuda version. + ### Running -## Animations +Any version of the program can be used to generate a visualizer compatible `.grid` file. +All versions of the program support the same command line arguments +The performance flag outputs information in the format of `<PROGRAM>,<FRACTAL>,<RUNTIME>`. +Note that the runtime is an average runtime from multiple runs. +The number of runs can be adjusted directly in `src/fractals.c` in `NUM_RUNS` or passed set in `CPPFLAGS` by adding `-DNUM_RUNS=N` + +``` +Usage: PROGRAM [-v] [-i iterations] [-x x_res] [-y y_res] [-z magnification] [-l lower_left] [-u upper_right] [-o output_grid] -f fractal +Options: + -i, --iterations <value> the number of iterations (default: 100) + -x, --x-res <value> the horizontal resolution (default: terminal width) + -y, --y-res <value> the vertical resolution (default: terminal height) + -l, --lower-left <value> Set the lower left corner of the fractal area (default: -2-2i) + -u, --upper-right <value> Set the upper right corner of the fractal area (default: 2+2i) + -z, --magnification <value> Set the magnification factor (default: 1) + -o, --output <filename> the output filename (default: fractal.grid) + -f, --fractal <type> the fractal type (default: mandelbrot) + supported fractals: mandelbrot, tricorn, multibrot, multicorn, burning_ship, julia + -p, --performance print performance info + -v, --verbose verbose output + -h, --help prints this help message +``` + +## Visualizations ## Presentation |