From eedd898f771df05b045bf77780b659aeb71400c7 Mon Sep 17 00:00:00 2001
From: Cassie Jones <code@witchoflight.com>
Date: Fri, 6 Mar 2020 23:24:51 +0100
Subject: [PATCH] Add README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bcbfe64
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# NaN Gate Synthesis
+
+## Installation
+
+Make sure you have `yosys` installed and can run the `pmgen` tool.
+Then, run:
+
+```shell
+$ make install
+```
+
+This should install the plugin in your Yosys data directory.
+
+## Usage
+
+You'll need to load the plugin in Yosys.
+You can either launch Yosys with:
+
+```shell
+$ yosys -m nangate
+```
+
+Or you can load it in your synthesis scripts, with:
+
+```shell
+plugin -i nangate
+```
+
+You can synthesize circuits to NaN gates with the `synth_nan` command.
+Read its help message for flags.
+
+You'll want to run `synth_nan` before you synthesize for a particular target, and you'll want to make sure you don't flatten your design when you end up synthesizing, or else the optimizer will do a good job removing all of the NaN-gate logic and converting it back into pure boolean logic.
-- 
2.43.2