LailaTheElf/rp2040-project-template
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a section about feature flags to README.md (#68)

Browse Source 
Closes #52
This commit is contained in:
Jan Niehusmann 2023-10-18 12:03:01 +02:00 committed by GitHub
parent a2d9df3ab6
commit 92f6a55ebc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -21,6 +21,7 @@ If you aren't using a debugger (or want to use other debugging configurations),
<li><a href="#running">Running</a></li>
<li><a href="#alternative-runners">Alternative runners</a></li>
<li><a href="#notes-on-using-rp2040_boot2">Notes on using rp2040_boot2</a></li>
<li><a href="#feature-flags">Feature flags</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#code-of-conduct">Code of conduct</a></li>
@ -228,6 +229,18 @@ Some of the options for your `runner` are listed below:
</details>
<!-- Feature flags -->
<details open="open">
<summary><h2 style="display: inline-block" id="feature-flags">Feature flags</h2></summary>
There are several [feature flags in rp2040-hal](https://docs.rs/rp2040-hal/latest/rp2040_hal/#crate-features).
If you want to enable some of them, uncomment the `rp2040-hal` dependency in `Cargo.toml` and add the
desired feature flags there. For example, to enable ROM functions for f64 math using the feature `rom-v2-intrinsics`:
```
rp2040-hal = { version="0.9", features=["rt", "critical-section-impl", "rom-v2-intrinsics"] }
```
</details>
<!-- ROADMAP -->
## Roadmap