litex/misoclib/com/liteeth/doc/source/docs/index.rst

28 lines
820 B
ReStructuredText

.. _documentation-home:
========================
LiteEth Documentation
========================
This comprehensive documentation set contains everything you need to know to use LiteEth and integrate it in your design.
**Getting started:**
- :ref:`intro-index` explains what LiteEth does, why it is needed, its limitations and its licensing. It will help you understand whether LiteEth is the right core for you.
- :ref:`getting-started-index` walks you through downloading, installing and using the LiteEth core.
**LiteEth Internals:**
- :ref:`core-index` describes core building blocks.
- :ref:`frontend-index` describes core building blocks.
The full hierarchy of articles, opened to the second level, is shown below.
.. toctree::
:maxdepth: 2
intro/index
getting_started/index
core/index
frontend/index