aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorJP Appel <jeanpierre.appel01@gmail.com>2024-04-22 09:50:46 -0400
committerJP Appel <jeanpierre.appel01@gmail.com>2024-04-22 09:50:46 -0400
commit6166388fd9c3e18b211b7c30fea39c8a95e24e16 (patch)
tree552b5f36cc62ba9ba3283e92ffd68a85eac69de8
parent00b488b32fa5e40151bf63443821c5b3c1840217 (diff)
update readme and todo
-rw-r--r--README.md13
-rw-r--r--TODO.md1
2 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index e7a80cd..cbe1389 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,21 @@ Final Project for Moravian University CSCI 392: High Performance Computing.
## Program
+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 image plotting program works with [ImageMagick](https://www.openmp.org/) 7+. Earlier versions may work but are not supported.
+
### Building
+To build all versions simply run
+
+```bash
+make
+```
+
### Running
## Animations
diff --git a/TODO.md b/TODO.md
index 14b78da..e17b9eb 100644
--- a/TODO.md
+++ b/TODO.md
@@ -4,6 +4,7 @@
* [ ] find way to render data into image files
* [x] read/write grids to/from file
+ * [ ] create image with ImageMagick core/wand
* [x] write serial
* [x] mandelbrot
* [x] multibrot