From d170c7f0be51f7675b2ec3377f8d359a01272129 Mon Sep 17 00:00:00 2001 From: Luke Kenneth Casson Leighton Date: Tue, 4 May 2021 15:58:03 +0100 Subject: [PATCH] update README --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 77adfea..aadd9ad 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,22 @@ # NMigen Util -This project implements utilities for nmigen. Its development is covered -under an NLNet Grant and the top-level bugreport is here: -http://bugs.libre-riscv.org/show_bug.cgi?id=62 +This project implements utilities for nmigen. It is semi-equivalent +to Chisel3 io library. Its development is covered under an NLNet Grant +and the top-level bugreport is here: +http://bugs.libre-soc.org/show_bug.cgi?id=62 + +Documentation: https://libre-soc.org/docs # Requirements * nmigen * yosys (latest git repository, required by nmigen) * pyvcd (for stylish GTKWave documents) - available on Pypi + +# Installation + +best done using the dev-env-setup scripts +https://git.libre-soc.org/?p=dev-env-setup.git;a=summary + +Also available on pypi: pip3 install libresoc-nmutil + -- 2.30.2