diff --git a/docs/Chipyard-Basics/Initial-Repo-Setup.rst b/docs/Chipyard-Basics/Initial-Repo-Setup.rst index 7b7042ee..499939f4 100644 --- a/docs/Chipyard-Basics/Initial-Repo-Setup.rst +++ b/docs/Chipyard-Basics/Initial-Repo-Setup.rst @@ -1,6 +1,13 @@ Initial Repository Setup ======================================================== +Requirements +------------------------------------------- + +Chipyard is developed and tested on Linux-based systems. +It is possible to use this on macOS or other BSD-based systems, although GNU tools will need to be installed; it is also recommended to install the RISC-V toolchain from ``brew``. +Working under Windows is not recommended. + Checking out the sources ------------------------ @@ -28,6 +35,6 @@ But to get a basic installation, just the following steps are necessary. ./scripts/build-toolchains.sh esp-tools # for a modified risc-v toolchain with Hwacha vector instructions -Once the script is run, a ``env.sh`` file is emitted at sets the ``PATH``, ``RISCV``, and ``LD_LIBRARY_PATH`` environment variables. +Once the script is run, a ``env.sh`` file is emitted that sets the ``PATH``, ``RISCV``, and ``LD_LIBRARY_PATH`` environment variables. You can put this in your ``.bashrc`` or equivalent environment setup file to get the proper variables. These variables need to be set for the make system to work properly. diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index f37f6597..6940713b 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -1,6 +1,13 @@ Quick Start =============================== +Requirements +------------------------------------------- + +Chipyard is developed and tested on Linux-based systems. +It is possible to use this on macOS or other BSD-based systems, although GNU tools will need to be installed; it is also recommended to install the RISC-V toolchain from ``brew``. +Working under Windows is not recommended. + Setting up the Chipyard Repo -------------------------------------------