riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs: getting_started tidy 

Rename `show` intro and point to `/cmd/show`.
Add getting_started section overview.
This commit is contained in:
Krystine Sherwin 2024-01-22 11:35:00 +13:00
parent 65bb0d3059
commit 9ec1536f1f
No known key found for this signature in database
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/getting_started/index.rst
View File

@ -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

7
docs/source/getting_started/scripting_intro.rst
View File

@ -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.