added requirements file

2024-06-20 19:58:33 +02:00
parent bb1d7dc008
commit 5cfd9d6a5d
1 changed files with 12 additions and 1 deletions
@@ -1 +1,12 @@
-# Mandelbrot
+# 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.
+