diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..e35d8850 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index 936597e6..86d62b11 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -28,22 +28,27 @@ To build the toolchains, you should run: .. Note:: If you are planning to use the Hwacha vector unit, or other RoCC-based accelerators, you should build the esp-tools toolchains by adding the ``esp-tools`` argument to the script above. If you are running on an Amazon Web Services EC2 instance, intending to use FireSim, you can also use the ``--ec2fast`` flag for an expedited installation of a pre-compiled toolchain. +Finally, set up Chipyard's environment variables and put the newly built toolchain on your path: + +.. code-block:: shell + + source ./env.sh What's Next? ------------------------------------------- This depends on what you are planning to do with Chipyard. -* If you want to learn about the structure of Chipyard, go to :ref:`chipyard-components`. +* To learn about the structure of Chipyard, see :ref:`chipyard-components`. -* If you intend to build one of the vanilla Chipyard examples, go to :ref:`build-a-chip` and follow the instructions. +* To build one of the vanilla Chipyard examples, see :ref:`build-a-chip`. -* If you intend to add a new accelerator, go to :ref:`adding-an-accelerator` and follow the instructions. +* To add a new accelerator, see :ref:`adding-an-accelerator`. -* If you intend to run a simulation of one of the vanilla Chipyard examples, go to :ref:`sw-rtl-sim-intro` and follow the instructions. +* To run a simulation of one of the Chipyard examples, see :ref:`sw-rtl-sim-intro`. -* If you intend to run a simulation of a custom Chipyard SoC Configuration, go to <> and follow the instructions. +* To run a simulation of a custom Chipyard SoC Configuration, see <>. -* If you intend to run a full-system FireSim simulation, go to :ref:`firesim-sim-intro` and follow the instructions. +* To run a FPGA-accelerated simulation using FireSim, see :ref:`firesim-sim-intro`. -* If you intend to run a VLSI flow using one of the vanilla Chipyard examples, go to <> and follow the instructions. +* To run a VLSI flow using one of the vanilla Chipyard examples, see <>.