Cairo By Example

Learn Cairo with examples (Live code editor included)

Using

If you'd like to read Cairo by Example, you can visit https://cairo-lang.org/cairo-by-example/ to read it online.

If you'd like to read it locally, install Rust, and then:

git clone https://github.com/cairo-lang/cairo-by-example
cd cairo-by-example
cargo install mdbook
mdbook build
mdbook serve

The following warnings can be ignored safely.

[WARN] (mdbook::preprocess::cmd): The command wasn't found, is the "gettext" preprocessor installed?
[WARN] (mdbook::preprocess::cmd):   Command: mdbook-gettext

Development

• Install cairo-listings

  cargo install --git https://github.com/enitrat/cairo-listings

• Install mdbook-cairo

  cargo install --git https://github.com/enitrat/mdbook-cairo

Formatting

cairo-listings format

Verifying compilation and tests

cairo-listings verify