From 0def6d02f9e198777f4f958bdd6073cdcc49e49d Mon Sep 17 00:00:00 2001 From: whitequark Date: Sat, 4 Jul 2020 02:09:35 +0000 Subject: [PATCH] docs: link to community tutorials until we have an official one. --- docs/index.rst | 1 + docs/lang.rst | 2 +- docs/start.rst | 2 +- docs/tutorial.rst | 11 +++++++++++ 4 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 docs/tutorial.rst diff --git a/docs/index.rst b/docs/index.rst index 3b273ca..cade289 100644 --- 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 d9f870b..4c71f0b 100644 --- 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 ` 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 8ebd898..972a287 100644 --- 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 ` 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 ` for a step-by-step introduction to the language, and the :doc:`language guide ` 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 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 `_ by Vivonomicon; + * `nMigen Step by Step Tutorial `_ by LambdaConcept; + * `"I want to learn nMigen" `_ by kbob; + * `A tutorial for using nMigen `_ by Robert Baruch. -- 2.30.2