Refactor examples - Githubissues

dcuddeback / libusb-rs

A safe Rust wrapper for libusb.

MIT License

199 stars 64 forks source link

Refactor examples #13

Closed Nicoretti closed 7 years ago

Nicoretti commented 7 years ago

Add info about examples to README
Rename example files
- examples/read_device.rs -> examples/device_info.rs
- examples/libusb_info.rs -> examples/libinfo.rs
- examples/list_devices.rs -> examples/usbtree.rs
Add cargo build configurations for examples
- device-info
- libinfo
- usbtree

oberien commented 7 years ago

You can run examples by just using cargo run --example NAME.

Nicoretti commented 7 years ago

Thx for pointing that out, haven't been aware of that.

dcuddeback commented 7 years ago

@Nicoretti As @oberien pointed out, examples are a first-class citizen of Cargo. My primary use case for writing the examples is to run manual tests. They're not exactly intended to be used as tools by end users, so I think calling them out in the README is misleading.