diff options
| author | Brian Cully <bjc@kublai.com> | 2019-08-11 12:37:21 -0400 |
|---|---|---|
| committer | Brian Cully <bjc@kublai.com> | 2019-08-11 12:48:06 -0400 |
| commit | e8739872b482872adf9b18ef2b5419098f8fadb3 (patch) | |
| tree | 3956b680f26c495cdddf7b71ad656e2ed14c2cc0 /README.md | |
| parent | b0be48424e81384de3280b5a5ac521d694b82e15 (diff) | |
| download | usb-host-e8739872b482872adf9b18ef2b5419098f8fadb3.tar.gz usb-host-e8739872b482872adf9b18ef2b5419098f8fadb3.zip | |
Add documentation and tests.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -3,11 +3,23 @@ This is a collection of traits that mediate between drivers for USB peripherals and USB Host. +# Warning + This is still very early days, yet, and everything should be considered experimental. However, it has been used to write a [driver for a boot protocol keyboard](https://github.com/bjc/bootkbd), and can presumably be used for other drivers as well. +The traits and structures defined in this crate are probably not +sufficient for general use. They are being kept purposefully minimal +to ease maintenance burden for implementors of these traits. If you +think there need to be further definitions, please open an issue (or, +even better, a pull request) on github describing the need. + + +A (partial) list of things that need to be changed, or at least looked +at, is maintained in `TODO.org`. + # Device driver crates. * [bootkbd](https://github.com/bjc/bootkbd) - A very simple boot-protocol keyboard driver. |