mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-08-11 21:50:54 +00:00
Code Activity

docs: moving code examples

Browse source 
Code now resides in `docs/source/code_examples`.
`CHAPTER_Prog` -> `stubnets`
`APPNOTE_011_Design_Investigation` -> `selections` and `show`
`resources/PRESENTATION_Intro` -> `intro`
`resources/PRESENTATION_ExSyn` -> `synth_flow`
`resources/PRESENTATION_ExAdv` -> `techmap`,  `macc`, and `selections`
`resources/PRESENTATION_ExOth` -> `scrambler` and `axis`

Note that generated images are not yet configured to build from the new code locations.
This commit is contained in:
Krystine Sherwin 2023-11-14 12:55:39 +13:00
parent 3d70867809
commit dbc38d72cf
No known key found for this signature in database
119 changed files with 264 additions and 905 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/source/getting_started/examples.rst
View file

@ -53,13 +53,13 @@ Simple synthesis script
~~~~~~~~~~~~~~~~~~~~~~~
This section covers an example project available in
``docs/resources/PRESENTATION_Intro/*``. The project contains a simple ASIC
``docs/source/code_examples/intro/*``. The project contains a simple ASIC
synthesis script (``counter.ys``), a digital design written in Verilog
(``counter.v``), and a simple CMOS cell library (``mycells.lib``).
.. literalinclude:: ../../resources/PRESENTATION_Intro/counter.ys
.. literalinclude:: /code_examples/intro/counter.ys
:language: yoscrypt
:caption: ``docs/resources/PRESENTATION_Intro/counter.ys``
:caption: ``docs/source/code_examples/intro/counter.ys``
.. role:: yoscrypt(code)
:language: yoscrypt
@ -89,18 +89,18 @@ synthesis script (``counter.ys``), a digital design written in Verilog
Running the script
^^^^^^^^^^^^^^^^^^
.. literalinclude:: ../../resources/PRESENTATION_Intro/counter.v
.. literalinclude:: /code_examples/intro/counter.v
:language: Verilog
:caption: ``docs/resources/PRESENTATION_Intro/counter.v``
:caption: ``docs/source/code_examples/intro/counter.v``
.. literalinclude:: ../../resources/PRESENTATION_Intro/mycells.lib
.. literalinclude:: /code_examples/intro/mycells.lib
:language: Liberty
:caption: ``docs/resources/PRESENTATION_Intro/mycells.lib``
:caption: ``docs/source/code_examples/intro/mycells.lib``
Step 1
""""""
.. literalinclude:: ../../resources/PRESENTATION_Intro/counter.ys
.. literalinclude:: /code_examples/intro/counter.ys
:language: yoscrypt
:lines: 1-3
@ -112,7 +112,7 @@ Result:
Step 2
""""""
.. literalinclude:: ../../resources/PRESENTATION_Intro/counter.ys
.. literalinclude:: /code_examples/intro/counter.ys
:language: yoscrypt
:lines: 5-6
@ -124,7 +124,7 @@ Result:
Step 3
""""""
.. literalinclude:: ../../resources/PRESENTATION_Intro/counter.ys
.. literalinclude:: /code_examples/intro/counter.ys
:language: yoscrypt
:lines: 8-9
@ -136,7 +136,7 @@ Result:
Step 4
""""""
.. literalinclude:: ../../resources/PRESENTATION_Intro/counter.ys
.. literalinclude:: /code_examples/intro/counter.ys
:language: yoscrypt
:lines: 11-18