Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs #148

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Update docs #148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
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