Skip to content
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.

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

Create a project template #54

Closed
Rahix opened this issue Aug 18, 2020 · 5 comments
Closed

Create a project template #54

Rahix opened this issue Aug 18, 2020 · 5 comments
Labels
documentation Documentation/Examples help wanted Extra attention is needed

Comments

@Rahix
Copy link
Owner

Rahix commented Aug 18, 2020

Similar to cortex-m-quickstart, we should provide a cargo-generate template for AVR. I'm not sure how exactly to design that to make it easy to start with any device from the same template but I'm sure there is a way to make this work. Otherwise, several templates for different popular boards could also work.

@Rahix Rahix added the help wanted Extra attention is needed label Oct 2, 2020
@ToddG
Copy link
Contributor

ToddG commented Oct 22, 2020

I wrote this for my own use a few days ago:

https://github.com/ToddG/arduino-rust-seed

Basically it uses python + cookiecutter to generate an application from templates.

@koutoftimer
Copy link

koutoftimer commented Feb 16, 2021

I vote for orphan template-{board name} branches. Despite of branching support in liquid templates it will be a mess to write common template for every supported board. Separate branches are harder to support but easier to understand what is going on and easier to get involved for newcomers.

@ToddG also I'd disapprove using make or any other build system than cargo. If one would like to, he can add support for tool he used to. At least, you should be able to use cargo despite of existed configs for other build systems.

@Rahix
Copy link
Owner Author

Rahix commented Feb 17, 2021

I like the idea of having the templates as branches in this repo! We just need to make it super obvious where they are, because otherwise people will not find them...

I wouldn't go with a separate template for each board, but I do agree that we might need multiple templates for very diverging designs. But I would say that, for example, every board supported by the new arduino-hal from #117 can be supported from a single template.

I saw that cargo-generate is making progress on their issue cargo-generate/cargo-generate#17, so I think we can make use of that in the near future :)

@Rahix Rahix added the documentation Documentation/Examples label Feb 27, 2021
@Rahix
Copy link
Owner Author

Rahix commented Mar 13, 2021

For reference: The template should contain a rust-toolchain file (#124 (comment) and the toolchain file docs).

@Rahix
Copy link
Owner Author

Rahix commented Nov 1, 2021

@Rahix Rahix closed this as completed Nov 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation/Examples help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants