From f7138a8d715420777a04aeba4135d50662e1a229 Mon Sep 17 00:00:00 2001 From: Brendan Sweeney Date: Wed, 25 Sep 2019 12:53:08 -0700 Subject: [PATCH 1/3] Notes on building with macOS doesn't really work --- docs/Chipyard-Basics/Initial-Repo-Setup.rst | 17 ++++++++++++++++- docs/Quick-Start.rst | 15 +++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/Chipyard-Basics/Initial-Repo-Setup.rst b/docs/Chipyard-Basics/Initial-Repo-Setup.rst index 7b7042ee..5375a604 100644 --- a/docs/Chipyard-Basics/Initial-Repo-Setup.rst +++ b/docs/Chipyard-Basics/Initial-Repo-Setup.rst @@ -1,6 +1,21 @@ Initial Repository Setup ======================================================== +Requirements +------------------------------------------- + +Using Linux is recommended. +The provided scripts will not work on macOS out of the box, but they may be able to be modified to support it. +Working under Windows is not recommended. + +* dtc (design-tree-compiler) + +* GNU awk + +* GNU sed + +* GNU make + Checking out the sources ------------------------ @@ -28,6 +43,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 86d62b11..65b854b9 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -1,6 +1,21 @@ Quick Start =============================== +Requirements +------------------------------------------- + +Using Linux is recommended. +The provided scripts will not work on macOS out of the box, but they may be able to be modified to support it. +Working under Windows is not recommended. + +* dtc (design-tree-compiler) + +* GNU awk + +* GNU sed + +* GNU make + Setting up the Chipyard Repo ------------------------------------------- From 438bb8c785f84b5e0aceddb55dd7163012d28ffb Mon Sep 17 00:00:00 2001 From: Brendan Sweeney Date: Wed, 25 Sep 2019 17:26:44 -0700 Subject: [PATCH 2/3] [docs] [skip ci] Change based on Abe's comments --- docs/Chipyard-Basics/Initial-Repo-Setup.rst | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/Chipyard-Basics/Initial-Repo-Setup.rst b/docs/Chipyard-Basics/Initial-Repo-Setup.rst index 5375a604..499939f4 100644 --- a/docs/Chipyard-Basics/Initial-Repo-Setup.rst +++ b/docs/Chipyard-Basics/Initial-Repo-Setup.rst @@ -4,18 +4,10 @@ Initial Repository Setup Requirements ------------------------------------------- -Using Linux is recommended. -The provided scripts will not work on macOS out of the box, but they may be able to be modified to support it. +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. -* dtc (design-tree-compiler) - -* GNU awk - -* GNU sed - -* GNU make - Checking out the sources ------------------------ From 23b667ad765f345fc3a4a787d79197ce161bb31e Mon Sep 17 00:00:00 2001 From: Brendan Sweeney Date: Wed, 25 Sep 2019 17:27:10 -0700 Subject: [PATCH 3/3] [ci skip] [docs] Abe's comments 2 --- docs/Quick-Start.rst | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index 65b854b9..da2e2abc 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -4,18 +4,10 @@ Quick Start Requirements ------------------------------------------- -Using Linux is recommended. -The provided scripts will not work on macOS out of the box, but they may be able to be modified to support it. +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. -* dtc (design-tree-compiler) - -* GNU awk - -* GNU sed - -* GNU make - Setting up the Chipyard Repo -------------------------------------------