q5/README.md

Beginner friendly graphics powered by WebGPU, optimized for interactive art!

# <img src="https://q5js.org/q5js_logo.avif" height="64"> <img src="https://q5js.org/q5js_brand.avif" height="64">

## Visit [q5js.org](https://q5js.org)! 💫

q5 was designed to make creative coding fun and accessible for educators, artists, designers, and beginners. 🤝

- 100x faster than [p5.js][] ⚡️
- beginner friendly [documentation](https://q5js.org/learn) 📚
- compatible with popular addons, including [p5.sound][], [ml5.js][], and [q5play][] 🎮
- no dependencies, ~140kb minified 📦
- free and open source 🆓

```js
await Canvas(200);
circle(0, 0, 80);
```

## Documentation

The [q5 learn pages](https://q5js.org/learn) have interactive mini-examples.

See the [wiki](https://github.com/q5js/q5.js/wiki) for extended documentation.

## Support q5 💙

q5 is open source. Anyone can use it for free under the terms of the LGPL. 🎉

We need your support though! If you enjoy using q5, please donate via [GitHub Sponsors](https://github.com/sponsors/quinton-ashley), [ko-fi](https://ko-fi.com/q5play), or [Patreon](https://www.patreon.com/q5play).

## Contributing

Are you interested in writing code for q5.js or improving the q5 ecosystem? Contributions are welcome!

Please report issues or comment on existing issues before working on a pull request. Check out the [q5 project planning board](https://github.com/orgs/q5js/projects/1/views/1).

All contributors must agree to the [code of conduct](CODE_OF_CONDUCT.md).

## Licensing

q5.js was created by [Quinton Ashley](https://github.com/quinton-ashley) and [contributors](https://github.com/q5js/q5.js/graphs/contributors). It is free to use and open source licensed under the LGPLv3.

@LingDong- created the original q5xjs library which is Unlicense (public domain) licensed.

p5.js is licensed under the LGPLv2, small sections of p5' code directly copied into q5 are credited below. The rest of q5 is a new implementation of part of the p5 API. APIs are not copyrightable in the United States, as decided by the Supreme Court in the Google v Oracle case. q5 is not affiliated with The Processing Foundation.

## Credits

q5 was inspired by the incredible work of [Ben Fry](https://benfry.com) and [Casey Reas](https://x.com/REAS) on Java [Processing](https://processingfoundation.org/) from 2001 to 2023, [Lauren McCarthy](http://lauren-mccarthy.com)'s work on [p5.js](https://p5js.org) from 2013 to 2019, and all contributors to these projects.

Huge thanks to all the [q5 contributors](https://github.com/q5js/q5.js/graphs/contributors)!

@evanalulu, @Tezumie, @keturn, @ormaq, @bertubi, @RedWilly, @Dukemz, @LingDong-

WebGPU MSDF text rendering:
https://webgpu.github.io/webgpu-samples/?sample=textRenderingMsdf

WebGPU blendMode:
https://webgpufundamentals.org/webgpu/lessons/webgpu-transparency.html

HSLtoRGB:
https://stackoverflow.com/a/64090995/3792062

HSBtoHSL:
https://stackoverflow.com/a/66469632/3792062

OKLCHtoRGB:
https://gist.github.com/dkaraush/65d19d61396f5f3cd8ba7d1b4b3c9432
https://github.com/color-js/color.js/blob/main/src/spaces/oklch.js

A JS Implementation of Ziggurat Algorithm:
http://ziggurat.glitch.me/

p5.js Vector.slerp:
https://github.com/processing/p5.js/blob/v1.10.0/src/math/p5.Vector.js#L2803

p5.js random:
https://github.com/processing/p5.js/blob/1.1.9/src/math/noise.js

[p5.js]: https://p5js.org
[Processing]: https://processing.org
[p5.sound]: https://archive.p5js.org/reference/#/libraries/p5.sound
[ml5.js]: https://ml5js.org
[q5play]: https://q5play.org