summaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2022-11-24 18:52:37 +0000
committerYann Herklotz <git@yannherklotz.com>2022-11-24 18:52:51 +0000
commit098157d5bb4687e0131ee117b75845ed19a4b6bc (patch)
tree87d20a4823f074c962d7bc6b0f1c3581f56afd29 /README.org
parent46c49262fc9910ba5ff92e76d567ed2e4446fb41 (diff)
downloadbutterstick-098157d5bb4687e0131ee117b75845ed19a4b6bc.tar.gz
butterstick-098157d5bb4687e0131ee117b75845ed19a4b6bc.zip
Add initial files for icestorm
Diffstat (limited to 'README.org')
-rw-r--r--README.org16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.org b/README.org
index cb96c43..9c549b7 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,19 @@
#+title: ButterStick CPU
#+author: Yann Herklotz
+To build the example LED-blinking firmware for an HX8K Breakout Board and get
+a timing report (checked against the default 12MHz oscillator):
+
+#+begin_src shell
+$ make clean example.bin timing
+#+end_src
+
+To run all the simulation tests:
+
+#+begin_src shell
+$ make clean example_sim synth_sim route_sim FIRMWARE_COUNTER_BITS=4
+#+end_src
+
+(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.)