driftingnebula/interlinked
driftingnebula
/
interlinked
1
Fork 0
Code Issues Activity

Rewrite readme.

This commit is contained in:
Bauke 2022-09-26 15:02:35 +02:00
parent 530d04af36
commit abd4236665
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 3 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

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