Skip to content

Commit

Permalink
Merge pull request #148 from ckormanyos/update_docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
ckormanyos authored Aug 27, 2024
2 parents 37c7999 + 760e431 commit 214279f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ The commands are as shown below, where you need to specialize `--boost`, `--my_c

```sh
cd mandlebrot
./build_all --boost=../boost-root --my_cc=g++ --stdcc=c++20
./build_all.sh --boost=../boost-root --my_cc=g++ --stdcc=c++20
mkdir -p images/tmp
./test_mandelbrot.exe
```

The script [`build_all.sh`](./build_all.sh) is used to:
In summary, the script [`build_all.sh`](./build_all.sh) is used to:
- Build the JPEG, ZLIB and PNG libraries with GNUmake.
- Compile and link [`test_mandelbrot.cpp`](https://github.com/ckormanyos/mandelbrot/blob/main/test/test_mandelbrot.cpp) to obtain the test program `test_mandelbrot.exe`.
- Execute the test program via `./test_mandelbrot.exe`. The resulting JPEG and PNG images will be placed as a temporary file in the `images/tmp` folder.
Expand All @@ -98,6 +98,8 @@ You may need to supply your system's (or your desired local) path to boost.

Make the needed output image directory and run `test_mandelbrot.exe`.

### Optionally Use `gmp_float`

To optionally use `gmp_float`, the [GMP](https://gmplib.org) big-number backend,
instead of `cpp_dec_float`, where both backends are from
[`Boost.Multiprecision`](https://www.boost.org/doc/libs/1_86_0/libs/multiprecision/doc/html/index.html),
Expand Down

0 comments on commit 214279f

Please sign in to comment.