Files
chipyard/docs/index.rst
2019-05-17 14:33:58 -07:00

76 lines
1.7 KiB
ReStructuredText

.. ReBAR 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 ReBAR's documentation!
=================================
ReBAR is a 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 intergration between open-source and commercial tools for the development of systems-on-chip. New to ReBAR? Jump to the :ref:`rebar-basics` page for more info.
The documentation outline should look like this
Getting Started:
ReBAR-Basics
Initial-Setup/index
Creating-Configuration-Tutorial/index
Adding-An-Accelerator-Tutorial/index
Running-Simulations-Tutorial/index
Building-Chips-Tutorial/index
Generators:
Generators/Rocketchip/index
Generators/BOOM/index
Generators/Hwacha/index
Simulation:
Simulation/Open-Source-Simulators/index
Simulation/Commercial-Simulators/index
Simulation/FPGA-Based-Simulation/index
Production:
Production/VLSI-Physical-Design/index
Software/Toolchains/index
.. toctree::
:maxdepth: 3
:caption: Getting Started:
:numbered:
Getting-Started/index
:maxdepth: 3
:caption: Simulation:
:numbered:
Simulation/index
:maxdepth: 3
:caption: Generators:
:numbered:
Generators/index
:maxdepth: 3
:caption: Tools:
:numbered:
Tools/index
:maxdepth: 3
:caption: VLSI Production:
:numbered:
VLSI/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`