From abd4236665986c6675ec7b4e1c79bc0504b6c756 Mon Sep 17 00:00:00 2001 From: Bauke Date: Mon, 26 Sep 2022 15:02:35 +0200 Subject: [PATCH] Rewrite readme. --- README.md | 45 +++------------------------------------------ 1 file changed, 3 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index f86f3ce..06604d0 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,7 @@ -# driftingnebula +# 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 - -# Run only the projects starting with a given name. -pnpm start -- --filter 2022-03 - -# See all the other options. -pnpm start -- --help - -# Lint the code and run tests. -pnpm test -``` +> **Generative art with GIMP, GEGL and ImageMagick.** ## License -* Code: [GPL-3.0-or-later](LICENSE) -* Images: [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/) +Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/driftingnebula/driftingnebula/src/branch/main/LICENSE) for more information.