usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: link to community tutorials until we have an official one.

Browse source
This commit is contained in:
whitequark 2020-07-04 02:09:35 +00:00
parent f24f1b02e8
commit f1153352c0
4 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/index.rst
View file

@ -11,4 +11,5 @@ Language & toolchain
intro
install
start
tutorial
lang

2
docs/lang.rst
View file

@ -5,7 +5,7 @@ Language guide
This guide is a work in progress and is seriously incomplete!
This guide introduces the nMigen language in depth. It assumes familiarity with synchronous digital logic and the Python programming language, but does not require experience with any hardware description language.
This guide introduces the nMigen language in depth. It assumes familiarity with synchronous digital logic and the Python programming language, but does not require prior experience with any hardware description language. See the :doc:`tutorial <tutorial>` for a step-by-step introduction to the language.
.. TODO: link to a good synchronous logic tutorial and a Python tutorial?

2
docs/start.rst
View file

@ -1,7 +1,7 @@
Getting started
###############
This section demonstrates the basic nMigen workflow to provide a cursory overview of the language and the toolchain. See the :doc:`language guide <lang>` for a detailed introduction to the language.
This section demonstrates the basic nMigen workflow to provide a cursory overview of the language and the toolchain. See the :doc:`tutorial <tutorial>` for a step-by-step introduction to the language, and the :doc:`language guide <lang>` for a detailed explanation of every language construct.
.. TODO: add link to build system doc
.. TODO: add link to more complex examples?

11
docs/tutorial.rst Normal file
View file

@ -0,0 +1,11 @@
Tutorial
========
.. todo::
The official tutorial is still being written. Until it's ready, consider following one of the tutorials written by the nMigen community:
* `Learning FPGA Design with nMigen <https://vivonomicon.com/2020/04/14/learning-fpga-design-with-nmigen/>`_ by Vivonomicon;
* `nMigen Step by Step Tutorial <http://blog.lambdaconcept.com/doku.php?id=nmigen:tutorial>`_ by LambdaConcept;
* `"I want to learn nMigen" <https://github.com/kbob/nmigen-examples>`_ by kbob;
* `A tutorial for using nMigen <https://github.com/robertbaruch/nmigen-tutorial>`_ by Robert Baruch.