diff --git a/README.md b/README.md index df064ad..1c793f0 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ -# Mandelbrot \ No newline at end of file +# Mandelbrot +This is a simple Mandelbrot set generator written in Python. It uses the `numpy` and `matplotlib` libraries to generate and display the set. + +## Installation +To install the required libraries, run the following command: +```bash +pip install -r requirements.txt +``` + +## Usage +To generate the Mandelbrot set, simply run the `gpuset.py` script if you wish to use the GPU (highly suggested since it is computational demanding) or the `set.py` for the version that utilizes the CPU. The script will generate the set and display it in a new window. +