misoclib/mem/doc/source/docs/index.rst

   1 .. _documentation-home:
   2
   3 ========================
   4 LiteSATA Documentation
   5 ========================
   6
   7 This comprehensive documentation set contains everything you need to know to use LiteSATA and integrate it in your design.
   8
   9 **Getting started:**
  10
  11 - :ref:`intro-index` explains what LiteSATA does, why it is needed, its limitations and its licensing. It will help you understand whether LiteSATA is the right core for you.
  12 - :ref:`getting-started-index` walks you through downloading, installing and using the LiteSATA core.
  13
  14 **LiteSATA Internals:**
  15
  16 - :ref:`phy-index` describes PHY building blocks.
  17 - :ref:`core-index` describes core building blocks.
  18 - :ref:`frontend-index` describes core building blocks.
  19
  20 **LiteSATA Verifications:**
  21
  22 - :ref:`simulation-index` describes provided simulations.
  23 - :ref:`test-index` describes provided tests.
  24
  25 The full hierarchy of articles, opened to the second level, is shown below.
  26
  27 .. toctree::
  28         :maxdepth: 2
  29
  30         intro/index
  31         getting_started/index
  32         specification/index
  33         phy/index
  34         core/index
  35         frontend/index
  36         simulation/index