From 41d69c3ad7d8c813ed1fae6969c0c0f322d2ad94 Mon Sep 17 00:00:00 2001 From: whitequark Date: Sun, 16 Dec 2018 18:09:01 +0000 Subject: [PATCH] README: mention Yosys requirement. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 35ea905..3312c1b 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,12 @@ Other nMigen libraries are built on FHDL and provide various tools such as a sys See the [doc/](doc/) folder for more technical information. -nMigen is a direct descendant of [Migen](https://m-labs.hk/migen) rewritten from scratch to address many issues that became clear in the many years Migen has been used in production. nMigen provides an extensive compatibility layer that makes it possible to build and simulate most Migen designs unmodified, as well as integrate modules written for Migen and nMigen. +nMigen is a direct descendant of [Migen][] rewritten from scratch to address many issues that became clear in the many years Migen has been used in production. nMigen provides an extensive compatibility layer that makes it possible to build and simulate most Migen designs unmodified, as well as integrate modules written for Migen and nMigen. -nMigen is designed for Python 3.6 and newer. Note that nMigen is **not** spelled nMiGen. +nMigen is designed for Python 3.6 and newer. nMigen's Verilog backend depends on [Yosys][]; currently, the `master` branch of Yosys is required. + +[migen]: https://m-labs.hk/migen +[yosys]: http://www.clifford.at/yosys/ ### Introduction -- 2.30.2