From 9ec1536f1fe925b4426ad0367a0733a96c6ee951 Mon Sep 17 00:00:00 2001 From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com> Date: Mon, 22 Jan 2024 11:35:00 +1300 Subject: [PATCH] Docs: getting_started tidy Rename `show` intro and point to `/cmd/show`. Add getting_started section overview. --- docs/source/getting_started/index.rst | 4 +++- docs/source/getting_started/scripting_intro.rst | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst index 51628c67f..7a92c212a 100644 --- a/docs/source/getting_started/index.rst +++ b/docs/source/getting_started/index.rst @@ -1,7 +1,9 @@ Getting started with Yosys ========================== -.. todo:: brief overview for the getting started index +This section covers how to get started with Yosys, from installation to a guided +walkthrough of synthesizing a design for hardware, and finishing with an +introduction to writing re-usable Yosys scripts. .. toctree:: :maxdepth: 3 diff --git a/docs/source/getting_started/scripting_intro.rst b/docs/source/getting_started/scripting_intro.rst index 6e75a3bcc..e971432c0 100644 --- a/docs/source/getting_started/scripting_intro.rst +++ b/docs/source/getting_started/scripting_intro.rst @@ -97,8 +97,8 @@ Detailed documentation of the select framework can be found under .. _show_intro: -The show command -~~~~~~~~~~~~~~~~ +Displaying schematics +^^^^^^^^^^^^^^^^^^^^^ While the :cmd:ref:`select` command is very useful, sometimes nothing beats being able to see a design for yourself. This is where :cmd:ref:`show` comes @@ -190,5 +190,8 @@ expression instead. .. _GraphViz color docs: https://graphviz.org/doc/info/colors +For all of the options available to :cmd:ref:`show`, check the command reference +at :doc:`/cmd/show`. + .. seealso:: :ref:`interactive_show` on the :doc:`/using_yosys/more_scripting/interactive_investigation` page.