[doc] Clean up setup instruction pages.
Rename "Getting started" to "setup" so users are less tempted to start
with these pages (which assume you've already installed dependencies and
built software). And just in case, also link back to the main "Getting
Started" page from each one.
Signed-off-by: Jade Philipoom <jadep@google.com>
clean up build sw
diff --git a/doc/getting_started/index.md b/doc/getting_started/_index.md
similarity index 98%
rename from doc/getting_started/index.md
rename to doc/getting_started/_index.md
index bd3bb3a..cbba877 100644
--- a/doc/getting_started/index.md
+++ b/doc/getting_started/_index.md
@@ -118,7 +118,7 @@
## Step 4: Build OpenTitan Software
-Follow the [dedicated guide]({{< relref "getting_started_building_sw" >}}) to build OpenTitan's software, and then return to this page.
+Follow the [dedicated guide]({{< relref "build_sw" >}}) to build OpenTitan's software, and then return to this page.
## Step 5: Set up your Simulation Tool or FPGA
diff --git a/doc/getting_started/getting_started_build_sw.md b/doc/getting_started/build_sw.md
similarity index 82%
rename from doc/getting_started/getting_started_build_sw.md
rename to doc/getting_started/build_sw.md
index 6e319f6..4961695 100644
--- a/doc/getting_started/getting_started_build_sw.md
+++ b/doc/getting_started/build_sw.md
@@ -1,10 +1,8 @@
---
-title: Getting Started Building Software
+title: Building Software
---
-## Prerequisites
-
-_Make sure you followed the install instructions to [prepare the system]({{< relref "install_instructions#system-preparation" >}}) and install the [compiler toolchain]({{< relref "install_instructions#compiler-toolchain" >}})._
+_Before following this guide, make sure you've followed the [dependency installation instructions]({{< relref "getting_started" >}})._
## Building software with Meson
@@ -69,33 +67,6 @@
```console
./meson_init.sh -r
```
-
-### Bringing your own toolchain
-
-`./meson_init.sh` needs to know where the toolchain you are using is, and which tools from it should be used.
-
-If you are using the lowrisc-provided toolchain (obtained with `get-toolchain.py`), and it is installed in the default location (`/tools/riscv`), then `./meson_init.sh` does not need additional configuration.
-
-If you are using the lowrisc-provided toolchain, but have located it in a non-default location (using `get-toolchain.py -t /path/to/lowrisc/toolchain`), you can use the environment variable `TOOLCHAIN_PATH` to point to your toolchain location, like so:
-
-```console
-export TOOLCHAIN_PATH=/path/to/lowrisc/toolchain
-./meson_init.sh
-```
-
-If you have moved a lowrisc-provided toolchain (obtained with `get-toolchain.py`), you will need to update paths within the meson toolchain configuration files within the toolchain installation.
-These are called `meson-<triple>-<compiler>.txt`, and are present in toolchains since version 20200602-1.
-You can still use `TOOLCHAIN_PATH` to point to the toolchain location if you have updated the paths within these files.
-
-If you have built your own toolchain by following option 2 under [Installing Software Build Requirements]({{< relref "doc/ug/install_instructions/index#device-compiler-toolchain-rv32imc" >}}), then you need to point `./meson_init.sh` to your custom toolchain file using `-t FILE`:
-
-```console
-./meson_init -t /path/to/toolchain/file
-```
-
-If you do not specify your own toolchain configuration file (using `./meson_init.sh -t`), and `meson_init.sh` cannot find the default configuration in your toolchain, the legacy `toolchain.txt` from the main OpenTitan repository will be used.
-If `TOOLCHAIN_PATH` is set, this will be used to update any paths within the legacy configuration.
-
## Building Software with Bazel
The Mask ROM and many other software targets are built with (Bazel)[https://bazel.build/]
diff --git a/doc/getting_started/getting_started_dv.md b/doc/getting_started/setup_dv.md
similarity index 97%
rename from doc/getting_started/getting_started_dv.md
rename to doc/getting_started/setup_dv.md
index f72436c..35bc99c 100644
--- a/doc/getting_started/getting_started_dv.md
+++ b/doc/getting_started/setup_dv.md
@@ -1,7 +1,9 @@
---
-title: "Getting Started with Design Verification"
+title: "Design Verification Setup"
---
+_Before following this guide, make sure you've followed the [dependency installation and software build instructions]({{< relref "getting_started" >}})._
+
This document aims to enable a contributor to get started with a design verification (DV) effort within the OpenTitan project.
While most of the focus is on development of a testbench from scratch, it should also be useful to understand how to contribute to an existing effort.
Please refer to the [DV methodology]({{< relref "dv_methodology/index.md" >}}) document for information on how design verification is done in OpenTitan.
diff --git a/doc/getting_started/getting_started_formal.md b/doc/getting_started/setup_formal.md
similarity index 87%
rename from doc/getting_started/getting_started_formal.md
rename to doc/getting_started/setup_formal.md
index 5fda38e..5f401e0 100644
--- a/doc/getting_started/getting_started_formal.md
+++ b/doc/getting_started/setup_formal.md
@@ -1,7 +1,9 @@
---
-title: "Getting Started with Formal Verification"
+title: "Formal Verification Setup"
---
+_Before following this guide, make sure you've followed the [dependency installation and software build instructions]({{< relref "getting_started" >}})._
+
This document aims to enable a contributor to get started with a formal verification effort within the OpenTitan project.
While most of the focus is on development of a testbench from scratch, it should also be useful to understand how to contribute to an existing effort.
diff --git a/doc/getting_started/getting_started_fpga.md b/doc/getting_started/setup_fpga.md
similarity index 98%
rename from doc/getting_started/getting_started_fpga.md
rename to doc/getting_started/setup_fpga.md
index 5bb5221..ebe8639 100644
--- a/doc/getting_started/getting_started_fpga.md
+++ b/doc/getting_started/setup_fpga.md
@@ -1,7 +1,9 @@
---
-title: "Getting Started on FPGAs"
+title: "FPGA Setup"
---
+_Before following this guide, make sure you've followed the [dependency installation and software build instructions]({{< relref "getting_started" >}})._
+
Do you want to try out OpenTitan, but don't have a couple thousand or million dollars ready for an ASIC tapeout?
Running OpenTitan on an FPGA board can be the answer!
diff --git a/doc/getting_started/getting_started_verilator.md b/doc/getting_started/setup_verilator.md
similarity index 97%
rename from doc/getting_started/getting_started_verilator.md
rename to doc/getting_started/setup_verilator.md
index ab3958c..635ddc9 100644
--- a/doc/getting_started/getting_started_verilator.md
+++ b/doc/getting_started/setup_verilator.md
@@ -1,7 +1,9 @@
---
-title: Getting Started with Verilator
+title: Verilator Setup
---
+_Before following this guide, make sure you've followed the [dependency installation and software build instructions]({{< relref "getting_started" >}})._
+
## About Verilator
Verilator is a cycle-accurate simulation tool.
@@ -64,7 +66,6 @@
A program needs to be built for each until ROM functionality for code download is ready.
For that purpose compile the demo program with "simulation" settings, which adjusts the frequencies to better match the simulation speed.
-For more information on building software targets refer to the [Getting Started Building Software guide]({{< relref "getting_started_build_sw.md" >}}).
```console
$ cd $REPO_TOP
diff --git a/doc/ug/hw_design.md b/doc/ug/hw_design.md
index 46783f9..ea21437 100644
--- a/doc/ug/hw_design.md
+++ b/doc/ug/hw_design.md
@@ -1,5 +1,5 @@
---
-title: "Getting Started Designing Hardware"
+title: "Designing Hardware"
---
This document aims to clarify how to get started with a hardware design within the OpenTitan project.
