Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Latest commit

 

History

History
69 lines (50 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 2.56 KB

Contributing Guide

Thanks for contributing to the imxrt-async-hal project! Please open an issue when

  • you find a bug in the crate
  • you have an idea for a feature
  • something isn't clear in our documentation

The rest of this guide provides quick tips for working with these packages. Before you get started, make sure that you have the dependencies described in the README.

Running tests

Unit and documentation tests run on your host computer. You must specify the imxrt1060 chip variant for documentation tests,

cargo test --features imxrt1060

Generate docs

Use the typical cargo doc to locally browse API docs. You must specify a chip variant:

cargo doc --features imxrt1060 [--open]

To generate the documentation that includes feature hints -- the docs that docs.rs generates -- install a nightly compiler. Then, run

cargo +nightly rustdoc --features imxrt1060 [--open] -- --cfg docsrs

Resources

  • The Async Rust Book teaches you the basics of async programming in Rust. However, it's not specific to embedded systems.

  • The Embedded Rust Book to learn about embedded Rust development. However, it's not specific to async Rust.

  • i.MX RT reference manuals are available from NXP. The reference manuals describe the i.MX RT registers and peripheral capabilities. Go here, and select your processor. Then, go to "Documentation," and scroll down to "Reference Manual." You'll need a free NXP account to access the reference manuals.

  • i.MX RT data sheets are available as free downloads here. The data sheets are useful for understanding high-level capabilities of the i.MX RT processors. Select your processor, then go to "Documentation," then "Data Sheet."

  • For other code references, consider studying

    • the Zephyr Project.
    • the ARM CMSIS Packs. Here's the MIMXRT1062 pack; NXP and ARM also provide CMSIS packs for the other i.MX RT variants.
    • NXP's MCUXpresso SDK, available here.