update README

[nmutil.git] / README.md

diff --git a/README.md b/README.md
index 77adfea6e99334e793d42a3829ee1a883b29d3c6..aadd9adce2833d561b7f3d064c0cb517790c9763 100644 (file)
--- 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
+