summaryrefslogtreecommitdiffstats
path: root/scripts/icestorm/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/icestorm/readme.md')
-rw-r--r--scripts/icestorm/readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/scripts/icestorm/readme.md b/scripts/icestorm/readme.md
new file mode 100644
index 0000000..101391f
--- /dev/null
+++ b/scripts/icestorm/readme.md
@@ -0,0 +1,12 @@
+To build the example LED-blinking firmware for an HX8K Breakout Board and get
+a timing report (checked against the default 12MHz oscillator):
+
+ $ make clean example.bin timing
+
+To run all the simulation tests:
+
+ $ make clean example_sim synth_sim route_sim FIRMWARE_COUNTER_BITS=4
+
+(You must run the `clean` target to rebuild the firmware with the updated
+`FIRMWARE_COUNTER_BITS` parameter; the firmware source must be recompiled for
+simulation vs hardware, but this is not tracked as a Makefile dependency.)