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

Proposed change to the format of the examples #20

Open
dtbox2 opened this issue Sep 20, 2023 · 1 comment
Open

Proposed change to the format of the examples #20

dtbox2 opened this issue Sep 20, 2023 · 1 comment

Comments

@dtbox2
Copy link

dtbox2 commented Sep 20, 2023

Proposed change to the format of the examples:

Currently the repo is setup to use the example format:

cargo run --release --example http-client

to run each example.

I find this difficult for a number of reasons:

1.) Multiple apparent versions of the example source exist in the repo:

diff intro/http-client/src/main.rs intro/http-client/examples/http-client.rs

Having 2 different apparent source files for the same example in the repo could cause some unnecessary confusion.

2.) If you want to start a project based on that example, you're left with the very confusing process of trying to figure out how to integrate a new cargo generate folder with the example folder.

It would seem so much easier to just create each example as a matching set of a complete cargo generated project that can be a starting point. (Minus the git, vscode, wokwi integrations.)

The challenge:

The main challenge I see to this is that git/wokwi/vscode etc integrations that exists in the cargo generated project. I would suggest completely stripping them from the suggested examples.

@SergioGasquez
Copy link
Member

Basically, this approach was used to match what we currently have in https://github.com/esp-rs/std-training/. At the beginning of this repo, we only had the solutions of the exercises, which is another option.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

2 participants