👋🏻 Hi and welcome!

A small but important disclaimer. This project is not intended to teach you the language and tools (toolchains such as rust, llvm, gcc), system programming, gamedev and all other related stuff. It assumes that you already know it all at a sufficient level.

This wiki collects notes useful for using this project, but also for Playdate-aimed development in general.

Almost all crates in the repository require a nightly toolchain.

1. Because it uses a nightly permanently unstable feature build-std
2. Because not an ounce of fear or danger is given by the nightly toolchain, then why not. If this scares you, just research what a nightly channel exactly is and how it differs from a stable channel.

MNRV: All tests are run on a nightly toolchain that specified version.

So, you'll need following for the most of the crates here:

1. Rust nightly toolchain (rustup is optional, but highly recommended)
2. Playdate SDK
   • for the playdate-sys and tools, ensure that env var PLAYDATE_SDK_PATH points to the SDK root. This is optional, but good way to help the tools to find SDK, and also useful if you have more then one version of SDK.
3. Follow the official documentation
   • Ensure that arm-none-eabi-gcc or gcc-arm-none-eabi in your PATH
4. Follow the instructions for playdate-sys
5. Follow the instructions for cargo-playdate