Create the readme.

This commit is contained in:
Bauke 2022-03-07 23:46:43 +01:00
parent f5043efce2
commit a298982f18
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 35 additions and 0 deletions

35
README.md Normal file
View File

@ -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
```