mirror of
https://github.com/YosysHQ/yosys
synced 2025-04-07 01:54:10 +00:00
e34a25ea27
Blocking tasks are now capital TODO (compared to non-blocking todo). Updated some of the todos. Added note about which intel synth does which families. Rename extended Yosys universe to Yosys family. Added brief text to landing page, and also a note about the restructure and where to find old docs. Moved todolist above ToC in preparation for disabling it in the config (so that it doesn't need it's own header). Fixed pdf build, was previously breaking on trying to include the svg badges.
45 lines
1.4 KiB
ReStructuredText
45 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
|
|
|
|
introduction
|
|
getting_started/index
|
|
using_yosys/index
|
|
yosys_internals/index
|
|
test_suites
|
|
|
|
appendix
|