Skip to content

Commit e767a16

Browse files
committed
Update README.md
Address review comments.
1 parent da8729c commit e767a16

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# CHERIoT Specification and Sail model
22

3-
This repository contains the specification for the [CHERIoT](https://cheriot.org) ISA. It consists of a document written in [latex](/archdoc) which includes exerpts of the [reference model](/src) written in [Sail](http://github.com/rems-project/sail).
3+
This repository contains the specification for the [CHERIoT](https://cheriot.org) ISA.
4+
It consists of a document written in [latex](/archdoc) which includes exerpts of the [reference model](/src) written in [Sail](http://github.com/rems-project/sail).
45
The [current draft architecture document](https://microsoft.github.io/cheriot-sail/cheriot-architecture.pdf) built from this repository contains a full description of the ISA and its intended use by [CHERIoT RTOS](https://github.com/microsoft/cheriot-rtos/).
5-
The Sail code is used to build an instruction set simulator which is included in the [CHERIoT RTOS dev containter](https://github.com/microsoft/cheriot-rtos/blob/main/docs/GettingStarted.md). It can also be used to prove [properties](properties) of the ISA using Sail's SMT support.
6+
The Sail code is used to build an instruction set simulator which is included in the [CHERIoT RTOS dev containter](https://github.com/microsoft/cheriot-rtos/blob/main/docs/GettingStarted.md).
7+
It can also be used to prove [properties](properties) of the ISA using Sail's SMT support.
68

7-
The architecture is based on the [CHERI specification](https://github.com/CTSRD-CHERI/cheri-specification). The code is dervied from [sail-cheri-riscv](http://github.com/CTSRD-CHERI/sail-cheri-riscv)
8-
and uses [sail-riscv](http://github.com/rems-project/sail-riscv) as a submodule.
9+
The architecture is based on the [CHERI specification](https://github.com/CTSRD-CHERI/cheri-specification).
10+
The code is dervied from [sail-cheri-riscv](http://github.com/CTSRD-CHERI/sail-cheri-riscv) and uses [sail-riscv](http://github.com/rems-project/sail-riscv) as a submodule.
911

1012
# Building
1113

12-
The easiest way to use the emulator is to use the dev container for the [CHERIoT RTOS](http://github.com/microsoft/cheriot-rtos).
14+
The easiest way to use the emulator is to use the dev container for the CHERIoT RTOS as described in the [getting started guide](https://github.com/microsoft/cheriot-rtos/blob/main/docs/GettingStarted.md).
1315

1416
Alternatively, if you wish to build from source you must first install dependencies, including Sail. For example, on Ubuntu 20.04 we have tested:
1517

0 commit comments

Comments
 (0)