summaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
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.)