Skip to content

doc: Document the project creation process #99

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

Merged
9names merged 2 commits into from
May 16, 2025
Merged

doc: Document the project creation process #99

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5edb9f
doc: Document the project creation process
ithinuel May 13, 2025
58170c8
fix: typo in readme.md introduced in the previous commit
ithinuel May 16, 2025
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
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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
Expand All @@ -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
Copy link
Member

@9names 9names May 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer the brief syntax that assumes github hosting, in case folks are typing this out instead of copy-pasting.

Suggested change
cargo generate --git https://github.com/rp-rs/rp2040-project-template
cargo generate rp-rs/rp2040-project-template

Copy link
Member

@9names 9names May 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also we have installation instructions for everything else, but not for cargo generate.

```

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_probe.md`.
- Remove the `cargo-generate` directory.
- Remote/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.tml` to select your favorite runner.

</details>

<!-- Running -->
<details open="open">
Expand Down