Skip to content

Commit 0516740

Browse files
siku2Rahix
authored andcommitted
docs: add Cargo.toml update step to README
1 parent 7f027c2 commit 0516740

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,14 @@ To add a new chip:
3838
but it should not include the top-level `_svd` key, as that's handled by the
3939
build system; If patching is unneeded (it's almost always needed!), the file
4040
can be omitted.
41-
4. Include the module into the tree, in [`devices.rs`](./src/devices.rs),
41+
4. Add the module as a feature in [`Cargo.toml`](./Cargo.toml), enabling `device-selected`.
42+
5. Include the module into the tree, in [`devices.rs`](./src/devices.rs),
4243
following the format used by other modules in that file;
43-
5. Update [`lib.rs`](./src/lib.rs) to conditionally `use` the new MCU module,
44+
6. Update [`lib.rs`](./src/lib.rs) to conditionally `use` the new MCU module,
4445
and add it to the lists of selected and available MCUs in the doc comment.
45-
6. Finally, try building the crate for your MCU with
46+
7. Finally, try building the crate for your MCU with
4647
`cargo build --features <mcu>,rt`.
47-
7. Also check the built documentation for inconsistencies, via
48+
8. Also check the built documentation for inconsistencies, via
4849
`cargo doc --features <mcu>,rt --open` (it will pop up in your browser).
4950

5051
## Internals

0 commit comments

Comments
 (0)