From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Tue, 4 May 2021 14:58:03 +0000 (+0100)
Subject: update README
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d170c7f0be51f7675b2ec3377f8d359a01272129;p=nmutil.git

update README
---

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
+