Hardware
/
litex
mirror of https://github.com/enjoy-digital/litex.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README: use markdown

This commit is contained in:
Sebastien Bourdeauducq 2014-09-10 20:49:49 +08:00
parent 325ffdc6c6
commit 92e51f10b1
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README → README.md
View File

@ -1,5 +1,5 @@
Migen (Milkymist generator) ## Migen (Milkymist generator)
a Python toolbox for building complex digital hardware ### a Python toolbox for building complex digital hardware
Despite being faster than schematics entry, hardware design with Verilog and Despite being faster than schematics entry, hardware design with Verilog and
VHDL remains tedious and inefficient for several reasons. The event-driven VHDL remains tedious and inefficient for several reasons. The event-driven
@ -10,7 +10,7 @@ fertile ground for subtle bugs in designs. Finally, support for procedural
generation of logic (metaprogramming) through "generate" statements is very generation of logic (metaprogramming) through "generate" statements is very
limited and restricts the ways code can be made generic, reused and organized. limited and restricts the ways code can be made generic, reused and organized.
To address those issues, we have developed the Migen FHDL library that To address those issues, we have developed the **Migen FHDL** library that
replaces the event-driven paradigm with the notions of combinatorial and replaces the event-driven paradigm with the notions of combinatorial and
synchronous statements, has arithmetic rules that make integers always behave synchronous statements, has arithmetic rules that make integers always behave
like mathematical integers, and most importantly allows the design's logic to like mathematical integers, and most importantly allows the design's logic to
@ -27,8 +27,15 @@ written in Python.
See the doc/ folder for more technical information. See the doc/ folder for more technical information.
Quick intro: Code repository:
https://github.com/m-labs/migen
System-on-chip design based on Migen:
https://github.com/m-labs/misoc
Migen is designed for Python 3.3. Note that Migen is **not** spelled MiGen.
### Quick intro
```python
from migen.fhdl.std import * from migen.fhdl.std import *
from mibuild.platforms import m1 from mibuild.platforms import m1
plat = m1.Platform() plat = m1.Platform()
@ -38,22 +45,17 @@ counter = Signal(26)
m.comb += led.eq(counter[25]) m.comb += led.eq(counter[25])
m.sync += counter.eq(counter + 1) m.sync += counter.eq(counter + 1)
plat.build_cmdline(m) plat.build_cmdline(m)
```
Code repository: ### License
https://github.com/m-labs/migen
System-on-chip design based on Migen:
https://github.com/m-labs/misoc
Migen is designed for Python 3.3.
Migen is released under the very permissive two-clause BSD license. Under the Migen is released under the very permissive two-clause BSD license. Under the
terms of this license, you are authorized to use Migen for closed-source terms of this license, you are authorized to use Migen for closed-source
proprietary designs. proprietary designs.
Even though we do not require you to do so, those things are awesome, so please Even though we do not require you to do so, those things are awesome, so please
do them if possible: do them if possible:
* tell us that you are using Migen * tell us that you are using Migen
* put the Migen logo (doc/migen_logo.svg) on the page of a product using it, * put the Migen logo (doc/migen_logo.svg) on the page of a product using it,
with a link to m-labs.hk with a link to http://m-labs.hk
* cite Migen in publications related to research it has helped * cite Migen in publications related to research it has helped
* send us feedback and suggestions for improvements * send us feedback and suggestions for improvements
* send us bug reports when something goes wrong * send us bug reports when something goes wrong
@ -62,8 +64,6 @@ do them if possible:
complex and/or you are not sure how to proceed, feel free to discuss it on complex and/or you are not sure how to proceed, feel free to discuss it on
the mailing list or IRC (#m-labs on Freenode) beforehand. the mailing list or IRC (#m-labs on Freenode) beforehand.
Note that Migen is not spelled MiGen.
See LICENSE file for full copyright and license info. You can contact us on the See LICENSE file for full copyright and license info. You can contact us on the
public mailing list devel [AT] lists.m-labs.hk. public mailing list devel [AT] lists.m-labs.hk.