mirror of
https://github.com/YosysHQ/yosys
synced 2025-04-06 17:44:09 +00:00
e2e7065590
- Filling out index descriptions for `using_yosys` and `using_yosys/synthesis`. - To discourage skipping over these index pages, the toctree in `using_yosys/index` is hidden and instead has inline links to the two subsections. - Tidying todos. - Moves technology mapping to `techmap_synth`, leaving the techmap by example in the internals section. `yosys_flows` gets split up, with the coarse-grain intro replaced by `synthesis/index`, the extract pass moving to `synthesis/extract` and model checking to `more_scripting/model_checking`.
46 lines
1.4 KiB
ReStructuredText
46 lines
1.4 KiB
ReStructuredText
================================================================================
|
|
Yosys Open SYnthesis Suite
|
|
================================================================================
|
|
|
|
Yosys is an open source framework for RTL synthesis. To learn more about Yosys,
|
|
see :doc:`/introduction`. For a quick guide on how to get started using Yosys,
|
|
check out :doc:`/getting_started/index`. For the complete list of commands
|
|
available, go to :ref:`commandindex`.
|
|
|
|
.. note::
|
|
|
|
This documentation recently went through a major restructure. If you're
|
|
looking for something from the previous version and can't find it here,
|
|
please `let us know`_. Documentation from before the restructure can still
|
|
be found by switching to `version 0.36`_ or earlier. Note that the previous
|
|
theme does not include a version switcher.
|
|
|
|
.. _let us know: https://github.com/YosysHQ/yosys/issues/new/choose
|
|
.. _version 0.36: https://yosyshq.readthedocs.io/projects/yosys/en/0.36/
|
|
|
|
.. todo:: look into command ref improvements
|
|
|
|
- Search bar with live drop down suggestions for matching on title /
|
|
autocompleting commands
|
|
- Scroll the left sidebar to the current location on page load
|
|
- Also the formatting/linking in pdf is broken
|
|
|
|
.. todolist::
|
|
|
|
.. only:: html
|
|
|
|
Table of contents
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:includehidden:
|
|
|
|
introduction
|
|
getting_started/index
|
|
using_yosys/index
|
|
yosys_internals/index
|
|
test_suites
|
|
|
|
appendix
|