docs reorg

docs/Quick-Start.rst

@@ -0,0 +1,43 @@
+Quick Start
+===============================
+
+Setting up the Chipyard Repo
+-------------------------------------------
+
+Start by fetching Chipyard's sources. Run:
+
+.. code-block:: shell
+
+    git clone https://github.com/ucb-bar/chipyard.git
+    cd chipyard
+    ./scripts/init-submodules-no-riscv-tools.sh
+
+This will have initialized submodules and installed the RISC-V tools and
+other dependencies.
+
+Installing the RISC-V Tools
+-------------------------------------------
+
+We need to install the RISC-V toolchain in order to be able to run RISC-V programs using the Chipyard infrastructure.
+This will take about 20-30 minutes. You can expedite the process by setting a ``make`` environment variable to use parallel cores: ``export MAKEFLAGS=-j8``.
+TO build the toolchains, you should run: 
+
+::
+
+    ./scripts/build-toolchains.sh
+
+.. 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 expediated installation of a pre-compiled toolchain.
+
+
+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 <>.
+- If you intend to build one of the vanilla Chipyard examples, go to <> and follow the instructions.
+- If you intend to add a new accelerator, go to <> and follow the instructions.
+- 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.
+- If you intend to run a simulation of a custom Chipyard SoC Configuration, go to <> and follow the instructions.
+- If you intend to run a full-system FireSim simulation, go to :ref:`firesim-sim-intro` and follow the instructions.  
+- If you intend to run a VLSI flow using one of the vanilla Chipyard examples, go to <> and follow the instructions.