Skip to content

Commit 9695eb6

Browse files
authored
Update README.md
1 parent 4d53359 commit 9695eb6

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,24 @@ A mandelbrot fractal renderer implementing both perturbation and series approxim
1212
- Multiple save formats including PNG, EXR and KFR.
1313
- Utilises scaling and mantissa-exponent based extended precision to allow for arbitrary zoom, whilst maintaining good performance. Verified to be working at depths exceeding E50000. Theoretically, this is only limited by MPFR's precision.
1414

15-
## Usage
15+
## Compiling
1616
You need to be able to compile the 'rug' crate which requires a rust GNU toolchain. Look in the documentation for rug for more information on how to do this. Once all required dependencies have been installed, build the crate with:
1717

1818
```cargo build --release```
1919

20-
The created binary can then be used with some of the config files provided. For help with the options do:
20+
## Usage
21+
Information on the flags which can be passed to the rendered can be found with the command ```rust-fractal --help```. The renderer takes .toml files as input. There are two seperate files which can be defined to render an image, the options file and the location file. Settings in these files can be changed in order to change the output of the program. By default, there are 3 options files provided, which are:
22+
23+
- ```low.toml```: low quality settings for fast rendering and preview.
24+
- ```default.toml```: settings that are used by default if no config file is provided.
25+
- ```high.toml```: higher quality settings for final rendering.
2126

22-
```./target/release/main --help```
27+
Location files contain information on the specific location to be rendered, including the location, zoom level and rotation. Some examples of these files are stored in the ```./locations``` directory. A typical call to the renderer would then look like:
2328

24-
By default, an image of the set is placed in the ```./output``` folder with it's specific details. A typical call with custom settings would look like:
29+
- Linux: ```rust-fractal -o default.toml locations/flake.toml```
30+
- Windows: ```rust-fractal.exe -o default.toml locations/flake.toml```
2531

26-
```./target/release/main -o default.toml locations/flake.toml```
32+
Output images are placed in the ```./output``` folder.
2733

2834
## Acknowledgements
2935
- claude (blog, Kalles Fraktaler 2+)

0 commit comments

Comments
 (0)