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

doc: Document the project creation process (#99)

Browse Source 
* doc: Document the project creation process

* fix: typo in readme.md introduced in the previous commit

Co-authored-by: 9names <60134748+9names@users.noreply.github.com>

---------

Co-authored-by: 9names <60134748+9names@users.noreply.github.com>
This commit is contained in:
Wilfried Chauveau 2025-05-16 09:43:05 +01:00 committed by GitHub
parent 55928a6225
commit 920d2cc72f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -18,6 +18,7 @@ If you aren't using a debugger (or want to use other debugging configurations),
<ol>
<li><a href="#markdown-header-requirements">Requirements</a></li>
<li><a href="#installation-of-development-dependencies">Installation of development dependencies</a></li>
<li><a href="#project-creation">Project Creation</a></li>
<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>
@ -41,7 +42,6 @@ If you aren't using a debugger (or want to use other debugging configurations),
- flip-link - this allows you to detect stack-overflows on the first core, which is the only supported target for now.
- (by default) A [`probe-rs` installation](https://probe.rs/docs/getting-started/installation)
- A [`probe-rs` compatible](https://probe.rs/docs/getting-started/probe-setup) probe
You can use a second
@ -67,6 +67,31 @@ If you get the error ``binary `cargo-embed` already exists`` during installation
</details>
<!-- Creating the project -->
<details open="open">
<summary><h2 style="display: inline-block" id="project-creation">Creating your project</h2></summary>
### Using `cargo-generate`
```sh
cargo generate --git https://github.com/rp-rs/rp2040-project-template
```
Follow the wizard 🪄 and enjoy your new project.
### Downloading as a zip file or using GitHub's template support
Obtain a copy of the code, either by downloading this repository as a zip file or using GitHub's
template feature, then apply the following:
- Remove `debug_probes.md`.
- Remove the `cargo-generate` directory.
- Remove/edit `README.md`.
- If using vscode update `.vscode/launch.json`;
Else: remove this file.
- Edit `Cargo.toml` & adjust according to your project (especially its name).
- Edit `.cargo/config.toml` to select your favorite runner.
</details>
<!-- Running -->
<details open="open">