Skip to content

Latest commit

 

History

History
67 lines (33 loc) · 1.89 KB

README.md

File metadata and controls

67 lines (33 loc) · 1.89 KB
Raw

Doodle: Compositional Vector Graphics

Copyright Noel Welsh.

Doodle is a Scala library for compositional vector graphics.

Distributed under the Apache 2.0 license.

Using Doodle

Current Version

Doodle is a Scala 3 only project. The current release is shown above and is on the main branch.

To use Doodle add the following to your build.sbt:

// Doodle is currently published for Scala 3
libraryDependencies += "org.creativescala" %% "doodle" % "<version>"

replacing <version> with the latest version as shown above. (Be aware you only need the numeric part of the version. So use a string like "0.20.0" not "v0.20.0").

Scala 2.13 users should use version 0.19.0.

Documentation

Documentation is available on the microsite.

Creative Scala provides another source of documentation for Doodle. Creative Scala is a free introductory Scala ebook.

Community

Join the Creative Scala Discord.

Acknowledgements

Doodle was written by Noel Welsh with contributions from the contributors listed by Github.

Notes

These are notes for developers.

General Development

  • Use the build task in sbt to compile and test everything, and run formatting.
  • Use the prePR task for additional checks before submitting a PR.

Documentation

Thanks to the amazing Typelevel SBT plugin, documentation should be built on every push to the master branch.

Publishing

Push a tag of the form v0.14.0. Make sure tlBaseVersion matches the base version you're trying to release.