Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 636 Bytes

File metadata and controls

22 lines (16 loc) · 636 Bytes

CONTRIBUTING

This is a Rust project, so rustup is the best place to start.

Check out the .travis.yml file to get an idea on how to run tests and the like.

rustfmt & clippy

Haven't added these yet, but I am definitely planning on doing so.

the guide

The guide for this project is built using mdBook. Review their guide for more details on how to work with mdBook. Here are a few of the pertinents:

# Install the CLI.
cargo install mdbook

# Build the guide.
mdbook build

# Watch the FS for changes & rebuild.
mdbook watch