.. Chipyard documentation master file, created by
   sphinx-quickstart on Fri Mar  8 11:46:38 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Chipyard's documentation!
====================================

.. image:: ./_static/images/chipyard-logo.svg

Chipyard is a framework for designing and evaluating full-system hardware using agile teams.
It is composed of a collection of tools and libraries designed to provide an integration between open-source and commercial tools for the development of systems-on-chip.

.. IMPORTANT:: **New to Chipyard?** Jump to the :ref:`Chipyard-Basics/Initial-Repo-Setup:Initial Repository Setup` page for setup instructions.

Getting Help
------------

If you have a question about Chipyard that isn't answered by the existing
documentation, feel free to ask for help on the
`Chipyard Google Group <https://groups.google.com/forum/#!forum/chipyard>`_.

Table of Contents
-----------------

.. toctree::
   :maxdepth: 3
   :numbered:

   Chipyard-Basics/index

   Simulation/index

   Generators/index

   Tools/index

   VLSI/index

   Customization/index

   Software/index

   Advanced-Concepts/index

   TileLink-Diplomacy-Reference/index

   Prototyping/index


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
