From 7944dac4aa04399a368a1a15efbb3acc4446b655 Mon Sep 17 00:00:00 2001
From: Eddie Hung <eddieh@ece.ubc.ca>
Date: Wed, 20 Feb 2019 13:41:19 -0800
Subject: Update README.md

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 4654ba5..010e12a 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,11 @@
 This repo is intended for use as a submodule from [YosysHQ/nextpnr](https://github.com/YosysHQ/nextpnr)
 
 Initial contents were populated from [YosysHQ/nextpnr@6cc1bf](https://github.com/YosysHQ/nextpnr/commit/6cc1bfcb37199e0988d0f06ce34071b409ab8019)
+
+# Notes for regressions:
+- Add subdir to `:/<arch>/regressions/<issue####>`; e.g. `:/ice40/regressions/issue0000`
+- `:/<arch>/regressions/Makefile` will take all `:/<arch>/regressions/*/*.{json.gz,sh}` and
+  - For `*.json.gz`: decompress into `*.json`, and then execute `nextpnr` using `*.pcf` if it exists, and using additional options specified by `*.npnr`
+  - For `*.sh`: decompress `*.json.gz` into `*.json`, then run `*.sh` script
+  - After executing `nextpnr`, will run `icebox_vlog` on the generated `*.asc` as a sanity check
+  - Non zero exit code of `nextpnr`, `*.sh`, or `icebox_vlog` constitutes a test failure
-- 
cgit v1.2.3