Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 858 Bytes

CONTRIBUTE.md

File metadata and controls

27 lines (17 loc) · 858 Bytes
Raw

Contribute

The guide is written with mdbook. The source for the guide is in the macroquad-introduction-book directory.

To run the guide on your machine you need to have mdbook and some plugins installed.

Install mdbook and plugins

  1. cd macroquad-introduction-book
  2. cargo install mdbook
  3. cargo install mdbook-quiz
  4. cargo install mdbook-catppuccin
  5. cargo install mdbook-admonish

Run the guide

  1. mdbook serve (Ignore any warnings/errors about plugin versions.)
  2. Open https://localhost:3000 in your browser of choice.

PRs welcome

If your contributions are larger than, say, correcting some typo, make sure your contribution is in line with the aims of this project. Please start by filing an issue about the thing you want to fix, to get feedback on which direction to take it.

Happy contributing!

❤️