Installation

If you haven't already, you can install the Rust Programming Language using rustup.

To create a new cargo project, run cargo new --bin <project-name>.

After creating the project, you can cd into the folder and then run cargo add maycoon to add maycoon as a dependency.

Feature Gates

Maycoon has feature gates that toggle special mechanics. You can configure them via the features key in the dependency descriptor:

[package]
name = "my_project"
description = "My Awesome App"
# other stuff...

[dependencies]
# '*' uses any compatible version (latest)
maycoon = { version = "*", features = ["canvas"] }

Following maycoon features are available:

  • vello-vg - Enables the vello rendering backend (enabled by default).
  • macros - Enables useful macros for easier development (enabled by default).
  • canvas - Enables the Canvas widget.
  • dummy-runner - Enables the dummy task runner.
  • tokio-runner - Enables the tokio task runner (enabled by default).
  • svg - Enables drawing Scaled-Vector-Graphics and the Icon widget.

NOTE: Maycoon requires that at least one -runner feature is enabled (e.g. tokio-runner).

Congratulations! You can now proceed to your first app.