Skip to content

Commit f2d4510

Browse files
committed
Add README.
1 parent f30f325 commit f2d4510

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[![crates.io](https://img.shields.io/crates/d/nrf-usbd.svg)](https://crates.io/crates/nrf-usbd)
2+
[![crates.io](https://img.shields.io/crates/v/nrf-usbd.svg)](https://crates.io/crates/nrf-usbd)
3+
![Build Status](https://github.com/nrf-rs/nrf-usbd/workflows/CI/badge.svg)
4+
5+
# `nrf-usbd`
6+
7+
> [usb-device](https://github.com/mvirkkunen/usb-device) implementation for Nordic Semiconductor nRF
8+
microcontrollers.
9+
10+
## Supported microcontrollers
11+
12+
* `nrf52840`
13+
* `nrf52833`
14+
* `nrf52820`
15+
* `nrf5340`, maybe?
16+
17+
## Usage
18+
19+
This driver is relatively low-level, and is intended for use through a HAL library.
20+
Such HAL library should implement `UsbPeripheral` for the corresponding USB peripheral object.
21+
This trait declares all the peripheral properties that may vary from one device family to the other.
22+
23+
## Examples
24+
25+
See the [`nrf-hal`](https://github.com/nrf-rs/nrf-hal) for the reference HAL implementation.
26+
27+
See the [`example`](./example) directory for an example on how to use it standalone without a HAL. This is
28+
discouraged, the recommended usage is through `nrf-hal`.

0 commit comments

Comments
 (0)