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

diff --git a/docs/index.rst b/docs/index.rst
index 3b273caeb004ed03eb0c01c592c21df98140c551..cade2898a523ad5b2eb1f26c232a64ca78a58eb1 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,4 +11,5 @@ Language & toolchain
    intro
    install
    start
+   tutorial
    lang

diff --git a/docs/lang.rst b/docs/lang.rst
index d9f870ba63e15e2c8913dcd45f4aa86a927f4afe..4c71f0b14e8c33e3d513bd7db90a67c94466c5dd 100644 (file)
--- a/docs/lang.rst
+++ b/docs/lang.rst
@@ -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?
 

diff --git a/docs/start.rst b/docs/start.rst
index 8ebd8981b4df9ef45a259b2657f80aee60d79da5..972a2872f0e9a5a42ac4eebb6c79247f9e9ac494 100644 (file)
--- a/docs/start.rst
+++ b/docs/start.rst
@@ -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?

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
new file mode 100644 (file)
index 0000000..407b4cf
--- /dev/null
+++ b/docs/tutorial.rst
@@ -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.