Skip to content

Commit 0eb063f

Browse files
[doc] Move reference info to the end
This stops people in a workshop from getting stuck reading reference documentation when this is not necessary for doing the exercises.
1 parent 7f8a69e commit 0eb063f

3 files changed

Lines changed: 33 additions & 20 deletions

File tree

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ This repository contains software, build flows and examples for the [Sonata Syst
44
For a guide on how to get up and running on building software for the sonata board see the [getting started guide][].
55
After you are all set up, take a look at the [exercises][].
66

7-
[sonata system]: https://github.com/lowRISC/sonata-system
8-
[sonata pcb]: https://github.com/newaetech/sonata-pcb
7+
[Sonata System]: https://github.com/lowRISC/sonata-system
8+
[Sonata PCB]: https://github.com/newaetech/sonata-pcb
99
[getting started guide]: ./doc/getting-started.md
1010
[exercises]: ./exercises/README.md
1111

@@ -15,26 +15,13 @@ You are in the [`sonata-software`][] repository.
1515
This repository wraps the [`cheriot-rtos`][], which is included in this repository as a submodule.
1616
[`cheriot-rtos`][] contains the CHERIoT software stack as well as drivers for using the Sonata board; it is well documented by the [CHERIoT Programmer's Guide][].
1717

18-
Other repositories of note:
19-
- [`sonata-system`][]: holds the Sonata system RTL and bootloader which come together to generate the bitstream.
20-
- [`sonata-rp2040`][]: The firmware that is running on the Sonata's RP2040 microcontroller and emulates the 'SONATA' drive when you plug it into your computer.
21-
- [`CHERIoT-Platform/llvm-project`][]: The CHERIoT LLVM compiler toolchain.
22-
- [`cheriot-audit`][]: A tool to explore and verify the relationships between CHERIoT RTOS components.
23-
- [`CHERIoT-Platform/book`][]: The source of the [CHERIoT Programmer's Guide][].
24-
25-
For hardware documentation, see the [Sonata system book][].
18+
You do not need this to do the exercises but if you would like more detailed documentation about the hardware, see the [Sonata system book][].
2619

2720
[`sonata-software`]: https://github.com/lowRISC/sonata-software
2821
[`cheriot-rtos`]: https://github.com/CHERIoT-Platform/cheriot-rtos
29-
[`sonata-system`]: https://github.com/lowRISC/sonata-system
30-
[`sonata-rp2040`]: https://github.com/newaetech/sonata-rp2040
31-
[`CHERIoT-Platform/llvm-project`]: https://github.com/CHERIoT-Platform/llvm-project
32-
[`cheriot-audit`]: https://github.com/CHERIoT-Platform/cheriot-audit
33-
[`CHERIoT-Platform/book`]: https://github.com/CHERIoT-Platform/book
3422
[CHERIoT Programmer's Guide]: https://cheriot.org/book/
3523
[Sonata system book]: https://lowrisc.org/sonata-system/
3624

37-
3825
## License
3926

4027
Unless otherwise noted, everything in the repository is covered by the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html), Version 2.0.

SUMMARY.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ SPDX-License-Identifier: Apache-2.0
88

99
- [Getting started](./doc/getting-started.md)
1010
- [Running Sonata software](./doc/guide/running-software.md)
11-
- [Using Sonata IO](./doc/guide/sonata-io.md)
12-
13-
- [Exploring the CHERIoT RTOS](./doc/exploring-cheriot-rtos.md)
14-
- [Auditing firmware](./doc/auditing-firmware.md)
1511

1612
- [Exercises](./exercises/README.md)
1713
- [Hardware access control exercise](./exercises/hardware_access_control/README.md)
1814
- [Firmware auditing exercise](./exercises/firmware_auditing/README.md)
15+
16+
- [Reference](./doc/reference/README.md)
17+
- [Using Sonata IO](./doc/guide/sonata-io.md)
18+
- [Exploring the CHERIoT RTOS](./doc/exploring-cheriot-rtos.md)
19+
- [Auditing firmware](./doc/auditing-firmware.md)

doc/reference/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Reference
2+
3+
The rest of this book is reference and background information.
4+
This information is not necessary to do the exercises, but is still useful for the broader context.
5+
6+
You may also want to look at the other documentation available for Sonata and CHERIoT in general:
7+
- [`sonata-system`][]: holds the Sonata system RTL and bootloader which come together to generate the bitstream.
8+
This repository also has a rendered [Sonata system book][].
9+
- [`sonata-rp2040`][]: The firmware that is running on the Sonata's RP2040 microcontroller and emulates the 'SONATA' drive when you plug it into your computer.
10+
- [`sonata-pcb`][]: The printed circuit board design for Sonata.
11+
- [`cheriot-rtos`][]: The CHERIoT software stack as well as drivers for the Sonata board.
12+
- [`CHERIoT-Platform/llvm-project`][]: The CHERIoT LLVM compiler toolchain.
13+
- [`cheriot-audit`][]: A tool to explore and verify the relationships between CHERIoT RTOS components.
14+
- [`CHERIoT-Platform/book`][]: The source of the [CHERIoT Programmer's Guide][].
15+
16+
[`sonata-software`]: https://github.com/lowRISC/sonata-software
17+
[`cheriot-rtos`]: https://github.com/CHERIoT-Platform/cheriot-rtos
18+
[`sonata-system`]: https://github.com/lowRISC/sonata-system
19+
[`sonata-rp2040`]: https://github.com/newaetech/sonata-rp2040
20+
[`CHERIoT-Platform/llvm-project`]: https://github.com/CHERIoT-Platform/llvm-project
21+
[`cheriot-audit`]: https://github.com/CHERIoT-Platform/cheriot-audit
22+
[`CHERIoT-Platform/book`]: https://github.com/CHERIoT-Platform/book
23+
[CHERIoT Programmer's Guide]: https://cheriot.org/book/
24+
[Sonata system book]: https://lowrisc.org/sonata-system/
25+
[`sonata-pcb`]: https://github.com/newaetech/sonata-pcb

0 commit comments

Comments
 (0)