[site/docs] Add software READMEs
Make software more prominent in the documentation.
There are sporadic links to sw, make the existence clearer.
Signed-off-by: Tobias Wölfel <tobias.woelfel@mailbox.org>
diff --git a/_index.md b/_index.md
index 9ce8b8c..aa521c0 100644
--- a/_index.md
+++ b/_index.md
@@ -32,5 +32,7 @@
* Top-level SoC
* Ibex processor core
* Comportable IP blocks
+* [Software]({{< relref "sw" >}})
+ * READMEs of OpenTitan software
* [Tools]({{< relref "util" >}})
* READMEs of OpenTitan tools
diff --git a/sw/README.md b/sw/README.md
index b540f9c..359dabc 100644
--- a/sw/README.md
+++ b/sw/README.md
@@ -4,7 +4,7 @@
## Building
-OpenTitan software is built using [Meson](https://mesonbuild.com), although OpenTitan's project structure is sufficiently ideosyncratic that we use a custom workflow.
+OpenTitan software is built using [Meson](https://mesonbuild.com), although OpenTitan's project structure is sufficiently idiosyncratic that we use a custom workflow.
For example, to build the OpenTitan executable located at `sw/device/examples/hello_world` for FPGA, run the following commands:
```console
diff --git a/sw/_index.md b/sw/_index.md
new file mode 100644
index 0000000..ae492af
--- /dev/null
+++ b/sw/_index.md
@@ -0,0 +1,26 @@
+---
+title: "OpenTitan Software"
+---
+
+This is the landing spot for software documentation within the OpenTitan project.
+Primarily these are README files about different software components.
+More description and information can be found within the [Reference Manual]({{< relref "doc/rm" >}}) and [User Guide]({{< relref "doc/ug" >}}) areas.
+
+## Software READMEs
+
+* General build instruction [README.md]({{< relref "sw/README.md" >}})
+* Hello World example [README.md]({{< relref "sw/device/examples/hello_world/README.md" >}})
+* Boot ROM Overview [README.md]({{< relref "sw/device/boot_rom/README.md" >}})
+* SPI Flash [README.md]({{< relref "sw/host/spiflash/README.md" >}})
+* Device Tests [README.md]({{< relref "sw/device/tests/README.md" >}})
+* OpenTitan Software Library
+ * Standard Library [README.md]({{< relref "sw/device/lib/base/README.md" >}})
+ * Freestanding C Headers [README.md]({{< relref "sw/device/lib/base/freestanding/README.md" >}})
+ * Runtime Library [README.md]({{< relref "sw/device/lib/runtime/README.md" >}})
+ * Device-specific Symbols [README.md]({{< relref "sw/device/lib/arch/README.md" >}})
+ * DIF Library [README.md]({{< relref "sw/device/lib/dif/README.md" >}})
+* CoreMark benchmark [README.md]({{< relref "sw/device/benchmarks/coremark/README.md" >}})
+* Vendor in software [README.md]({{< relref "sw/vendor/README.md" >}})
+ * CoreMark [README.md]({{< relref "sw/vendor/eembc_coremark/README.md" >}})
+ * RISC-V Compliance [README.md]({{< relref "sw/vendor/riscv_compliance/README.md" >}})
+ * Google Test [README.md]({{< relref "sw/vendor/google_googletest/README.md" >}})
diff --git a/sw/device/tests/index.md b/sw/device/tests/README.md
similarity index 100%
rename from sw/device/tests/index.md
rename to sw/device/tests/README.md
