From ada2e58e475c00209d8ada8c7e85532cd0be58a5 Mon Sep 17 00:00:00 2001 From: Gabriel Tofvesson Date: Fri, 28 Feb 2020 23:55:18 +0100 Subject: [PATCH] Add explanation of -DPRINT_STATUS to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 86874aa..be2e4a8 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,13 @@ An optimization directive has been included in `board.c` to allow for the near complete removal of boundary checks and error conditions. To enable this optimization, simply add `-DOPTIMIZE` to your compiler flags. +## Live status output +If you would like to get a live status output of speculative value placement, +add the `-DPRINT_STATUS=[mask]` to your compiler flags. The mask specifies the +bitmask to be applied when determining after how many iterations to print a +board to the output. For example, `-DPRINT_STATUS=0xFFF` should print a board +every 4096th (0x1000) call to the simplification algorithm. + ## TODO * Optimizations