Skip to content

Commit

Permalink
update readmes with more info for new users
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobrosenthal authored and sajattack committed Feb 18, 2020
1 parent b2d559c commit c7dee21
Show file tree
Hide file tree
Showing 13 changed files with 294 additions and 16 deletions.
18 changes: 17 additions & 1 deletion boards/circuit_playground_express/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit Circuit Playground Express
board](https://www.adafruit.com/product/3333).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv6m-none-eabi`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/circuit_playground_express/examples

* Be in this directory `cd boards/circuit_playground_express`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/circuit_playground_express/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
35 changes: 34 additions & 1 deletion boards/edgebadge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,41 @@
This crate provides a type-safe API for working with the [Adafruit EdgeBadge
board](https://www.adafruit.com/product/4400).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv7em-none-eabihf`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/edgebadge/examples

* Be in this directory `cd boards/edgebadge`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/edgebadge/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```

Note some examples will tell you they need more features enabled
```
$ cargo hf2 --release --example neopixel_button
error: target `neopixel_button` in package `edgebadge` requires the features: `unproven`
Consider enabling them by passing, e.g., `--features="unproven"`
```
Just follow the instructions to add --features like
```
cargo hf2 --release --example neopixel_button --features="unproven"
Finished release [optimized + debuginfo] target(s) in 0.09s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/edgebadge/target/thumbv7em-none-eabihf/release/examples/neopixel_button"
Finished in 0.167s
$
```
18 changes: 17 additions & 1 deletion boards/feather_m0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit Feather M0
board](https://www.adafruit.com/product/2772).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv6m-none-eabi`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/feather_m0/examples

* Be in this directory `cd boards/feather_m0`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/feather_m0/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
18 changes: 17 additions & 1 deletion boards/feather_m4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit Feather M4
board](https://www.adafruit.com/product/3857).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv7em-none-eabihf`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/feather_m4/examples

* Be in this directory `cd boards/feather_m4`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/feather_m4/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
18 changes: 17 additions & 1 deletion boards/gemma_m0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit Gemma M0
board](https://www.adafruit.com/product/3501).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv6m-none-eabi`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/gemma_m0/examples

* Be in this directory `cd boards/gemma_m0`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/gemma_m0/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
18 changes: 17 additions & 1 deletion boards/itsybitsy_m0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit ItsyBitsy M0
board](https://www.adafruit.com/product/3727).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv6m-none-eabi`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/itsybitsy_m0/examples

* Be in this directory `cd boards/itsybitsy_m0`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/itsybitsy_m0/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
35 changes: 34 additions & 1 deletion boards/itsybitsy_m4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,41 @@ This crate provides a type-safe Rust API for working with the
- 192kB SRAM
- 2 MB SPI Flash chip

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv7em-none-eabihf`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/itsybitsy_m4/examples

* Be in this directory `cd boards/itsybitsy_m4`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/itsybitsy_m4/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```

Note some examples will tell you they need more features enabled
```
$ cargo hf2 --release --example usb_serial
error: target `usb_serial` in package `itsybitsy_m4` requires the features: `usb`, `use_uart_debug`
Consider enabling them by passing, e.g., `--features="usb use_uart_debug"`
```
Just follow the instructions to add --features like
```
cargo hf2 --release --example usb_serial --features="usb use_uart_debug"
Finished release [optimized + debuginfo] target(s) in 0.09s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/itsybitsy_m4/target/thumbv7em-none-eabihf/release/examples/usb_serial"
Finished in 0.167s
$
```
18 changes: 17 additions & 1 deletion boards/metro_m0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit Metro M0
board](https://www.adafruit.com/product/3505).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv6m-none-eabi`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/metro_m0/examples

* Be in this directory `cd boards/metro_m0`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/metro_m0/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
18 changes: 17 additions & 1 deletion boards/metro_m4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit Metro M4
board](https://www.adafruit.com/product/3382).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv7em-none-eabihf`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/metro_m4/examples

* Be in this directory `cd boards/metro_m4`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/metro_m4/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
35 changes: 34 additions & 1 deletion boards/pygamer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,41 @@
This crate provides a type-safe API for working with the [Adafruit PyGamer
board](https://www.adafruit.com/product/4242).

## Examples?
## Prerequisites
* Add the cross compile toolchain `rustup target add thumbv7em-none-eabihf`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/pygamer/examples

* Be in this directory `cd boards/pygamer`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyGamer"))
Flashing "/Users/User/atsamd/boards/pygamer/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```

Note some examples will tell you they need more features enabled
```
$ cargo hf2 --release --example neopixel_button
error: target `neopixel_button` in package `pygamer` requires the features: `unproven`
Consider enabling them by passing, e.g., `--features="unproven"`
```
Just follow the instructions to add --features like
```
cargo hf2 --release --example neopixel_button --features="unproven"
Finished release [optimized + debuginfo] target(s) in 0.09s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyGamer"))
Flashing "/Users/User/atsamd/boards/pygamer/target/thumbv7em-none-eabihf/release/examples/neopixel_button"
Finished in 0.167s
$
```
18 changes: 17 additions & 1 deletion boards/pyportal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,24 @@
This crate provides a type-safe API for working with the [Adafruit PyPortal
board](https://www.adafruit.com/product/4116).

## Examples?
## Prerequisites
* Install the cross compile toolchain `rustup target add thumbv7em-none-eabihf`
* Install [cargo-hf2 the hf2 bootloader flasher tool](https://crates.io/crates/cargo-hf2) however your platform requires

## Uploading an example
Check out the repository for examples:

https://github.com/atsamd-rs/atsamd/tree/master/boards/pyportal/examples

* Be in this directory `cd boards/pyportal`
* Put your device in bootloader mode usually by hitting the reset button twice.
* Build and upload in one step
```
$ cargo hf2 --release --example blinky_basic
Finished release [optimized + debuginfo] target(s) in 0.19s
Searching for a connected device with known vid/pid pair.
Trying Ok(Some("Adafruit Industries")) Ok(Some("PyBadge"))
Flashing "/Users/User/atsamd/boards/pyportal/target/thumbv7em-none-eabihf/release/examples/blinky_basic"
Finished in 0.079s
$
```
Loading

0 comments on commit c7dee21

Please sign in to comment.