Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Oct 18, 2023
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down