From a298982f18c615090792852d8918de12e78850fd Mon Sep 17 00:00:00 2001
From: Bauke <me@bauke.xyz>
Date: Mon, 7 Mar 2022 23:46:43 +0100
Subject: [PATCH] Create the readme.

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fe84ce7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# driftingnebula
+
+> Generative art with GIMP, GEGL and ImageMagick.
+
+## Usage
+
+To run the generations you'll need to have [GEGL 0.4], [git], [ImageMagick 7], [NodeJS] and [pnpm] installed. Then in a terminal, you can do the following things.
+
+[GEGL 0.4]: https://gegl.org
+[git]: https://git-scm.com
+[ImageMagick 7]: https://imagemagick.org/
+[NodeJS]: https://nodejs.org
+[pnpm]: https://pnpm.io
+
+```sh
+# Download the repository.
+git clone https://github.com/driftingnebula/driftingnebula
+cd driftingnebula
+
+# Install the NodeJS dependencies.
+pnpm install
+
+# Run the generations. See the "output" directory for files.
+pnpm start
+
+# Run the generations but don't render anything.
+pnpm start -- --no-render
+
+# Run the generations and explicitly include all the default
+# parameters for GEGL operations.
+pnpm start -- --include-defaults
+
+# Lint the code and run tests.
+pnpm test
+```