Witch of Git - nan-gate/blob - README.md

   1 # NaN Gate Synthesis
   2
   3 ## Installation
   4
   5 Make sure you have `yosys` installed and can run the `pmgen` tool.
   6 Then, run:
   7
   8 ```shell
   9 $ make install
  10 ```
  11
  12 This should install the plugin in your Yosys data directory.
  13
  14 ## Usage
  15
  16 You'll need to load the plugin in Yosys.
  17 You can either launch Yosys with:
  18
  19 ```shell
  20 $ yosys -m nangate
  21 ```
  22
  23 Or you can load it in your synthesis scripts, with:
  24
  25 ```shell
  26 plugin -i nangate
  27 ```
  28
  29 You can synthesize circuits to NaN gates with the `synth_nan` command.
  30 Read its help message for flags.
  31
  32 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.