rp-rs / rp2040-project-template

A basic rp2040-hal project with blinky and rtt logging example code. With this you can quickly get started on a new rp2040 project
489 stars 102 forks source link

Incompatible Template implementation options #90

Open moritztim opened 2 weeks ago

moritztim commented 2 weeks ago

Currently, this repository is set up as both a GitHub template repository and a cargo-generate template. This creates potential confusion and inconsistency in how users might initialize new projects.

There are currently two approaches to using this template and they are incompatible:

Both have drawbacks:

However, I believe that the drawbacks of the github approach are more significant and the original intended use seems to be through cargo-generate, so I suggest disabling the template setting on this repository and adding instructions to the readme.

This would provide a clearer, more maintainable path for users to create new projects based on this template.

Disclaimer: I used Anthropic's Claude LLM to provide a starting point for the structure for this issue.

9names commented 2 weeks ago

This is an incorrect read of the history of this template. The original intended method for using this template was cloning the repo or downloading it using the github download as zip button. Later we added the GitHub template option. Later than that we added cargo-generate support (once that tool was stable enough).

The intention is for this to work whichever way the end-user tries, so we don't have to force any specific tooling on them.

moritztim commented 2 weeks ago

I see. In that case, to minimize confusion, the cargo-generate support needs to be documented somewhere so users know that it's available and know that if they're not using it, they should remove it, as it's not really a part of the template if used in that way.