README.md

   1 # nMigen
   2
   3 ## A refreshed Python toolbox for building complex digital hardware
   4
   5 **nMigen is incomplete and undergoes rapid development. The nMigen documentation refers to features that may not be implemented yet and compatibility guarantees that may not hold yet. Use at your own risk.**
   6
   7 Despite being faster than schematics entry, hardware design with Verilog and VHDL remains tedious and inefficient for several reasons. The event-driven model introduces issues and manual coding that are unnecessary for synchronous circuits, which represent the lion's share of today's logic designs. Counterintuitive arithmetic rules result in steeper learning curves and provide a fertile ground for subtle bugs in designs. Finally, support for procedural generation of logic (metaprogramming) through "generate" statements is very limited and restricts the ways code can be made generic, reused and organized.
   8
   9 To address those issues, we have developed the *nMigen FHDL*, a library that replaces the event-driven paradigm with the notions of combinatorial and synchronous statements, has arithmetic rules that make integers always behave like mathematical integers, and most importantly allows the design's logic to be constructed by a Python program. This last point enables hardware designers to take advantage of the richness of the Python language—object oriented programming, function parameters, generators, operator overloading, libraries, etc.—to build well organized, reusable and elegant designs.
  10
  11 Other nMigen libraries are built on FHDL and provide various tools such as a system-on-chip interconnect infrastructure, a dataflow programming system, a more traditional high-level synthesizer that compiles Python routines into state machines with datapaths, and a simulator that allows test benches to be written in Python.
  12
  13 See the [doc/](doc/) folder for more technical information.
  14
  15 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.
  16
  17 nMigen is designed for Python 3.6 and newer. nMigen's Verilog backend depends on [Yosys][]; currently, the `master` branch of Yosys is required.
  18
  19 Thanks [LambdaConcept][] for being a sponsor of this project! Contact sb [at] m-labs.hk if you also wish to support this work.
  20
  21 [migen]: https://m-labs.hk/migen
  22 [yosys]: http://www.clifford.at/yosys/
  23 [lambdaconcept]: http://lambdaconcept.com/
  24
  25 ### Installation
  26
  27     pip install git+https://github.com/m-labs/nmigen.git
  28
  29 ### Introduction
  30
  31 TBD
  32
  33 ### Links
  34
  35 TBD
  36
  37 ### License
  38
  39 nMigen is released under the very permissive two-clause BSD license. Under the terms of this license, you are authorized to use nMigen for closed-source proprietary designs.
  40
  41 Even though we do not require you to do so, these things are awesome, so please do them if possible:
  42   * tell us that you are using nMigen
  43   * put the [nMigen logo](doc/nmigen_logo.svg) on the page of a product using it, with a link to https://m-labs.hk
  44   * cite nMigen in publications related to research it has helped
  45   * send us feedback and suggestions for improvements
  46   * send us bug reports when something goes wrong
  47   * send us the modifications and improvements you have done to nMigen as pull requests on GitHub
  48
  49 See LICENSE file for full copyright and license info.
  50
  51   "Electricity! It's like magic!"