Add Makefile modified for sphinx
[nmutil.git] / README.md
1 # NMigen Util
2
3 This project implements utilities for nmigen. It is semi-equivalent
4 to Chisel3 io library. Its development is covered under an NLNet Grant
5 and the top-level bugreport is here:
6 http://bugs.libre-soc.org/show_bug.cgi?id=62
7
8 Documentation: https://libre-soc.org/docs
9
10 # Requirements
11
12 * nmigen
13 * yosys (latest git repository, required by nmigen)
14 * pyvcd (for stylish GTKWave documents) - available on Pypi
15
16 # Installation
17
18 best done using the dev-env-setup scripts
19 https://git.libre-soc.org/?p=dev-env-setup.git;a=summary
20
21 Also available on pypi: pip3 install libresoc-nmutil
22