Skip to content

Commit e74987c

Browse files
committed
doc: Document the project creation process
1 parent 2e15359 commit e74987c

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ If you aren't using a debugger (or want to use other debugging configurations),
1818
<ol>
1919
<li><a href="#markdown-header-requirements">Requirements</a></li>
2020
<li><a href="#installation-of-development-dependencies">Installation of development dependencies</a></li>
21+
<li><a href="#project-creation">Project Creation</a></li>
2122
<li><a href="#running">Running</a></li>
2223
<li><a href="#alternative-runners">Alternative runners</a></li>
2324
<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),
4142
- flip-link - this allows you to detect stack-overflows on the first core, which is the only supported target for now.
4243

4344
- (by default) A [`probe-rs` installation](https://probe.rs/docs/getting-started/installation)
44-
4545
- A [`probe-rs` compatible](https://probe.rs/docs/getting-started/probe-setup) probe
4646

4747
You can use a second
@@ -67,6 +67,35 @@ If you get the error ``binary `cargo-embed` already exists`` during installation
6767

6868
</details>
6969

70+
<!-- Creating the project -->
71+
<details open="open">
72+
<summary><h2 style="display: inline-block" id="project-creation">Creating your project</h2></summary>
73+
74+
### Using `cargo-generate`
75+
76+
```sh
77+
cargo generate --git https://github.com/rp-rs/rp2040-project-template
78+
```
79+
80+
Follow the wizard 🪄 and enjoy your new project.
81+
82+
### Downloading as a zip file or using GitHub's template support
83+
84+
Once you have a copy of the code apply the following:
85+
- Remove `debug_probe.md`.
86+
- Remove the `cargo-generate` directory.
87+
- Remote/edit `README.md`.
88+
- If using vscode update `.vscode/launch.json`;
89+
Else: remove this file.
90+
- Edit `Cargo.toml` & adjust according to your project (especially its name).
91+
- Edit `.cargo/config.tml` to select your favorite runner.
92+
93+
### Downloading this repository as a zip or generating with github's template
94+
95+
From GitHub's UI, download this repository as a zip file and remove the `cargo-generate` directory.
96+
97+
### Generate with `cargo-generate`
98+
</details>
7099

71100
<!-- Running -->
72101
<details open="open">

0 commit comments

Comments
 (0)