Docs: sentence case titles

Sentence case titles are easier to read so changed those that didn't conform. Also choose "Sonata software" as name of repo.
lowRISC · Jan 17, 2025 · c3b2a01 · c3b2a01
1 parent bd622e9
commit c3b2a01
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Sonata Software
+# Sonata software
 
 This repository contains software, build flows and examples for the [Sonata System][] running on the [Sonata PCB][].
 For a guide on how to get up and running on building software for the sonata board see the [getting started guide][].

diff --git a/SUMMARY.md b/SUMMARY.md
@@ -2,17 +2,17 @@
 Copyright lowRISC Contributors.
 SPDX-License-Identifier: Apache-2.0
 -->
-# Sonata Software
+# Sonata software
 
 [Introduction](./README.md)
 
 - [Getting started](./doc/getting-started.md)
-  - [Running Sonata Software](./doc/guide/running-software.md)
+  - [Running Sonata software](./doc/guide/running-software.md)
   - [Using Sonata IO](./doc/guide/sonata-io.md)
 
 - [Exploring the CHERIoT RTOS](./doc/exploring-cheriot-rtos.md)
-- [Auditing Firmware](./doc/auditing-firmware.md)
+- [Auditing firmware](./doc/auditing-firmware.md)
 
 - [Exercises](./exercises/README.md)
-  - [Hardware Access Control Exercise](./exercises/hardware_access_control/README.md)
-  - [Firmware Auditing Exercise](./exercises/firmware_auditing/README.md)
+  - [Hardware access control exercise](./exercises/hardware_access_control/README.md)
+  - [Firmware auditing exercise](./exercises/firmware_auditing/README.md)
diff --git a/book.toml b/book.toml
@@ -5,7 +5,7 @@
 language = "en"
 multilingual = false
 src = "."
-title = "Sonata Software"
+title = "Sonata software"
 
 [output.html]
 git-repository-url = "https://github.com/lowRISC/sonata-software"

diff --git a/doc/auditing-firmware.md b/doc/auditing-firmware.md
@@ -1,4 +1,4 @@
-# Auditing Firmware
+# Auditing firmware
 
 This documentation provides an introduction to CHERIoT Audit, alongside a quick guide on developing auditing policies with Rego.
 You can find more comprehensive information about these tools in their relevant documentation:

diff --git a/doc/exploring-cheriot-rtos.md b/doc/exploring-cheriot-rtos.md
@@ -1,5 +1,6 @@
 # Exploring CHERIoT RTOS
-## CHERIoT RTOS Orientation
+
+## CHERIoT RTOS orientation
 All the software in this repository runs on the CHERIoT RTOS, which is pulled in at the root of this repository as a submodule named [`cheriot-rtos`].
 The [CHERIoT Programmer's Guide] contains most of what a programmer would need to know to use the RTOS.
 
@@ -13,7 +14,7 @@ The drivers (structures that map onto a peripherals' MMIO) add functionality can
 To explore the various utility libraries available, look through [`cheriot-rtos/sdk/include/`](../cheriot-rtos/sdk/include/).
 When first starting to explore capabilities, the [`CHERI::Capability`](../cheriot-rtos/sdk/include/cheri.hh) class is useful for pointer introspection.
 
-## Build System
+## Build system
 
 The CHERIoT RTOS uses [xmake][] as it's build system.
 The main rules you'll use are *compartment* and *library*, for creating compartments and libraries, as well as the *firmware* rule for creating a firmware image.

diff --git a/doc/guide/running-software.md b/doc/guide/running-software.md
@@ -1,4 +1,4 @@
-# Running Sonata Software
+# Running Sonata software
 
 You can either run software [on the sonata FPGA board](#running-on-the-sonata-fpga) or [in the sonata simulator](#running-in-the-simulator).
 We recommend you focus on the FPGA as you get started and return to the simulator if you find it useful later.

diff --git a/exercises/README.md b/exercises/README.md
@@ -2,8 +2,9 @@
 Copyright lowRISC Contributors.
 SPDX-License-Identifier: Apache-2.0
 -->
-# Sonata Software Exercises
-## Building the Exercises
+# Sonata software exercises
+
+## Building the exercises
 
 Assuming you've run through the [getting started guide][], you will have ran `xmake -P examples` and built the example firmware images.
 To build all the exercises, simply substitute `examples` for `exercises`.

diff --git a/exercises/hardware_access_control/README.md b/exercises/hardware_access_control/README.md
@@ -2,7 +2,7 @@
 Copyright lowRISC Contributors.
 SPDX-License-Identifier: Apache-2.0
 -->
-# Hardware Access Control Exercise
+# Hardware access control exercise
 
 If you haven't already, please go to the '[building the exercises][]' section to see how the exercises are built.
 

diff --git a/flake.nix b/flake.nix
@@ -1,7 +1,7 @@
 # Copyright lowRISC Contributors.
 # SPDX-License-Identifier: Apache-2.0
 {
-  description = "Sonata Software";
+  description = "Sonata software";
   inputs = {
     sonata-system.url = "github:lowRISC/sonata-system";
     lowrisc-nix.follows = "sonata-system/lowrisc-nix";

diff --git a/tests/README.md b/tests/README.md
@@ -1,4 +1,4 @@
-# Sonata Software Tests
+# Sonata software tests
 
 These tests test the sonata system's hardware.
 They are simple, only intended to catch regressions.