From c7e5123f6604fbb9ca510f01af9b60e777bf57b4 Mon Sep 17 00:00:00 2001
From: Ian McIntyre <ianpmcintyre@gmail.com>
Date: Sun, 22 Oct 2023 18:23:56 -0400
Subject: First commit

A prototype of an i.MX RT ENET driver. There's design decisions I'm
thinking of changing. Nevertheless, the smoltcp support seems to be
working; an 1170EVK can act as a DHCP client and a TCP loopback server.
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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
-- 
cgit v1.2.3