From 40d12d89c9c6f168f69a042f1b3ca134fa19b341 Mon Sep 17 00:00:00 2001 From: David Phillips Date: Fri, 24 Feb 2017 16:46:42 +1300 Subject: Update readme with usage details --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 1e7601e..75b1004 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,24 @@ # fractal-gen-opencl + Syntax + fractal-gen -p -s -i + + -p platform - name of the preferred OpenCL platform to use. If no platform + with this name is available, the first available platform + is selected and the user is warned. If you do not know the + name of the platform, set to a nonsense string like 'any'. + -s size - size of the image to generate in pixels (square image) + -i iterations - maximum number of iterations to use on each pixel to + determine its set membership + + This is a work-in-progress port of my simple fractal-gen software to OpenCL. That software was an experiment of mine to generate mandelbrot (and some of its cousin) fractals on the CPU. This is my attempt at porting that software to OpenCL so it can be used on a multitude of computation devices, chiefly GPUs. +## About + I had started to port it to CUDA in October 2016, but changed to CL because of its portability and open nature. -- cgit v1.1