Skip to content

Commit

Permalink
Add warning about extreme path length limit on Windows
Browse files Browse the repository at this point in the history
This is a very surprising gotcha and kind of a pain to have to regenerate & recompile your project if you didn't know about it. Which you definitely didn't.
  • Loading branch information
Timmmm authored Mar 13, 2024
1 parent 562ba85 commit 321711a
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/writing-your-own-application/generate-project/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Both templates are based on [`cargo-generate`][cargo-generate], a tool that allo
cargo install cargo-generate
```
2. Generate a project based on one of the templates:
> 🚨 **Warning**: On Windows the complete path to your project must be no more than 10 characters.
- `esp-template`:
```shell
cargo generate esp-rs/esp-template
Expand All @@ -24,7 +25,7 @@ Both templates are based on [`cargo-generate`][cargo-generate], a tool that allo

When the `cargo generate` subcommand is invoked, you will be prompted to answer several questions regarding the target of your application. Upon completion of this process, you will have a buildable project with all the correct configurations.

3. Build/Run the generated project:
4. Build/Run the generated project:
- Use `cargo build` to compile the project using the appropriate toolchain and target.
- Use `cargo run` to compile the project, flash it, and open a serial monitor with our target device.

Expand Down

0 comments on commit 321711a

Please sign in to comment.