aboutsummaryrefslogtreecommitdiffstats
path: root/examples/icestick/uart/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/icestick/uart/README.md')
-rwxr-xr-xexamples/icestick/uart/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/examples/icestick/uart/README.md b/examples/icestick/uart/README.md
new file mode 100755
index 0000000..b53def6
--- /dev/null
+++ b/examples/icestick/uart/README.md
@@ -0,0 +1,11 @@
+# icestick-uart
+Simple UART sender and receiver for the lattice icestick. It echoes every received word back.
+Configuration: 115200 8N1
+
+## Repository structure
+- hdl: Contains the hardware design.
+- syn: Contains the scripts and constraints for synthesis.
+
+## Usage
+- `cd syn && ./synth.sh`
+- configure and open putty or another serial terminal and type something \ No newline at end of file