From: whitequark Date: Fri, 28 Jun 2019 05:10:29 +0000 (+0000) Subject: README: tone down the instability warning to reflect current status. X-Git-Tag: locally_working~141 X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=f0a7f84a6dc81f5a69faa6865d831ad5c01ecb79;p=nmigen.git README: tone down the instability warning to reflect current status. --- diff --git a/README.md b/README.md index c50971b..8376625 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## A refreshed Python toolbox for building complex digital hardware -**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.** +**Although nMigen is incomplete and in active development, it can already be used for real-world designs. The nMigen language (`nmigen.ast`, `nmigen.dsl`) will not undergo incompatible changes. The nMigen standard library (`nmigen.lib`) and build system (`nmigen.build`) will undergo minimal changes before their design is finalized.** 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.