diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b85fc79 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# imxrt-enet + +An Ethernet driver for i.MX RT MCUs with support for `smoltcp`. + +## Development + +To build the driver in this repo, enable + +- an `imxrt-ral` feature. +- a `smoltcp` socket feature. + +For example, + +``` +cargo build --features=imxrt-ral/imxrt1062,smoltcp/socket-raw +``` + +If you're depending on this driver, you're expected to enable similar features +somewhere in your dependency graph. + +To test the driver on hardware, see the various ENET examples maintained with +[`imxrt-hal`]. + +[`imxrt-hal`]: https://github.com/imxrt-rs/imxrt-hal |