Add development instructions to Readme

[Walther]

Suggestion: add development instructions in the readme, to make contributing easier.
Let me know if there's more steps required!

Before running these steps, I wasn't able to run cargo check in the workspace:

cargo check
error: failed to read `/Users/walther/git/imxrt-rs/imxrt-ral/Cargo.toml`

Caused by:
  No such file or directory (os error 2)

After these steps, I can run cargo check, but I get 8324 errors 😅

errors.txt

error: aborting due to 8324 previous errors

Some errors have detailed explanations: E0425, E0432, E0433.
For more information about an error, try `rustc --explain E0425`.
error: could not compile `imxrt-hal`.

[mciantyre]

Thanks!

If you hit other contribution hiccups and need more information, let us know.

[Walther]

Any suggestions on how to fix the 8 thousand macro errors? I think there must be some other setup step I'm still missing 😅
imxrt-rs--errors.txt

[mciantyre]

Both the RAL and the HAL require that you to specify a feature flag. Are you specifying a feature-flag in your build?

The feature flag specifies the iMXRT variant we're using. The RAL supports all of the iMXRT chips; the HAL only supports the imxrt1062.

When developing the HAL crate for iMXRT1062 chips, I normally check the build with

cd imxrt-hal
cargo check --features imxrt1062

[Walther]

That was it, thank you! Maybe the feature flags should also be mentioned in the Readme 🤔

[Walther]

Addendum: how do I make rust-analyzer / editor integrations be aware of the feature flag you mentioned, or configure it on the workspace level? Editor seems to be unaware where to find most things

[mciantyre]

Thanks for working through that! I've added #53 as my task to improve documentation and contribution guidance for the project.

Addendum: how do I make rust-analyzer / editor integrations be aware of the feature flag you mentioned, or configure it on the workspace level?

This is something I'm still struggling with 😛Here's the .vscode settings that I've been using:

$ cat imxrt-hal/.vscode/settings.json

{
    "rust-analyzer.cargo.allFeatures": false,
    "rust-analyzer.cargo.features": [
        "imxrt1062"
    ],
    "rust-analyzer.checkOnSave.allTargets": false,
    "rust-analyzer.cargo.noDefaultFeatures": true,
    "rust-analyzer.checkOnSave.extraArgs": [
        "--features imxrt1062"
    ]
}

My workspace is typically the imxrt-hal directory itself, not the entire imxrt-rs project.

I've only recently adopted rust-analyzer, and may be some killer rust-analyzer features that I'm missing out on.