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

Please add build instructions #211

Open
Resonanz opened this issue Aug 23, 2024 · 2 comments
Open

Please add build instructions #211

Resonanz opened this issue Aug 23, 2024 · 2 comments

Comments

@Resonanz
Copy link

Please add the following noob build instructions into the Examples section of README.md:

How to run example code, for example "list_ports.rs":

cargo run --example list_ports
@RossSmyth
Copy link
Contributor

I don't think there's any reason to. That is a Cargo concern. One will learn how just by learning Rust or typing cargo --help.

https://doc.rust-lang.org/cargo/reference/cargo-targets.html

@sirhcel
Copy link
Contributor

sirhcel commented Aug 31, 2024

You are right @RossSmyth, this is about Rust basics.

On the other hand are we already providing an example of how to build the crate without default features in the README's Overview section. So I'm not against adding another example for list_ports there for a quick start with quick success.

Please feel free to open a PR @Resonanz.

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

No branches or pull requests

3 participants