From 2f9d4a6348cadbf19be88e767acb3ce30b958920 Mon Sep 17 00:00:00 2001
From: Donald Sebastian Leung
Date: Fri, 23 Oct 2020 10:39:16 +0800
Subject: [PATCH] Add instructions for running verification
---
README.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/README.md b/README.md
index 5d01018..ca51801 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,14 @@ Formally verified implementation of the ARTIQ RTIO core in nMigen
- `shell.nix`: Nix file for setting up the environment for this project
- `rtio`: RTIO core in nMigen
+## Running the verification tasks
+
+Currently, only the sorting network contains assertions to be verified. To run the verification tasks for the sorting network, change directory to the root of this project and do
+
+```bash
+$ python -m rtio.test.sed.output_network
+```
+
## Progress
- Devise a suitable migration strategy for `artiq.gateware.rtio` from Migen to nMigen