From f73069bd4ba5c7d006c2eafe05e5b098beec3be0 Mon Sep 17 00:00:00 2001 From: Brian Cully Date: Tue, 8 Oct 2019 10:14:19 -0400 Subject: Update README.md. * Remove broken reference to sample code. * Add feature flag docs. --- README.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 3f1bb0a..ffcdcd7 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,20 @@ This is a [usb-host](https://github.com/bjc/usb-host) driver for Atmel's SAMD series of chips. -# Examples - -## (Sort of) Simple Example +# Feature flags -This assumes you have an [Adafruit Trinket -M0](https://www.adafruit.com/product/3500). You'll need to make -modifications to `Makefile` and `examples/simple/main.rs` for your -board otherwise. +To enable support for your MCU, you need to enable its feature. One +of: `samd21g18a`, `samd21e18a`, `samd51g19a`, `samd51j19a`, +`samd51j20a`. -You'll need at least `bossac` installed somewhere in your path in -order to actually do the flashing. You'll also need rust installed for -your target device. +So far this library has been tested on the following boards: -1) Connect a serial port to your device (the Trinket M0 uses pin 4 to -do UART transmission at TTL voltage). + - [Adafruit Trinket M0](https://www.adafruit.com/product/3500) + (samd21e18a) + - [Adafruit Feather M0](https://www.adafruit.com/product/2772) + (samd21g18a) -2) Plug the device in, put it into firmware-update mode (double-tap -the reset button on the Trinket M0) and run `make flash`. When it's -done you should see boot messages on your serial device. +# Examples -3) Unplug the device from the computer, hook it up to another power -supply somehow (I wire GND to ground and USB to 5V), plug in a -keyboard, and hit some keys. You should see it print out the keyboard -reports as keys are pressed and released. Alternately, you may see -error messages if something is broken. +You can find a project utilizing this library for a USB to I²C bridge +[here](https://github.com/bjc/bleusb/tree/master/usb). -- cgit v1.2.3