From 4d62a2b215a5f00098a8c4cf3383868bb1507b7d Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 8 Mar 2019 09:51:55 -0800 Subject: [PATCH] docs placeholder --- docs/index.rst | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 docs/index.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d8f3db3 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,61 @@ +.. ReBAR documentation master file, created by + sphinx-quickstart on Thu Apr 26 23:51:51 2018. + 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. + +.. toctree:: + :maxdepth: 3 + :caption: Getting Started: + :numbered: + + ReBAR-Basics + Initial-Setup/index + Creating-Configuration-Tutorial/index + Adding-An-Accelerator-Tutorial/index + Running-Simulations-Tutorial/index + Building-Chips-Tutorial/index + +.. toctree:: + :maxdepth: 3 + :caption: Generators: + + Generators/Rocketchip/index + Generators/BOOM/index + Generators/Hwacha/index + + +.. toctree:: + :maxdepth: 3 + :caption: Simulation: + + Simulation/Open-Source-Simulators/index + Simulation/Commercial-Simulators/index + Simulation/FPGA-Based-Simulation/index + + + +.. toctree:: + :maxdepth: 3 + :caption: Production: + + Production/VLSI-Physical-Design/index + + +.. toctree:: + :maxdepth: 3 + :caption: Software: + + Software/Toolchains/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`