Skip to content

Commit da8729c

Browse files
committed
Update README.md
Add link to latest pdf version of arch doc hosted on github pages.
1 parent 1064c99 commit da8729c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

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

3-
This repository contains an implementation of the CHERIoT ISA in [Sail](http://github.com/rems-project/sail).
4-
It contains an executable description of the CHERIoT instruction set that can be used to build an instruction set emulator and also prove [properties](properties) of the ISA using Sail's SMT support.
5-
A full description of the ISA, including extracts from this repository, can be found in the [CHERIoT technical report](https://aka.ms/cheriot-tech-report).
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).
4+
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.
66

7-
The code is dervied from [sail-cheri-riscv](http://github.com/CTSRD-CHERI/sail-cheri-riscv)
8-
and uses the [sail-riscv](http://github.com/rems-project/sail-riscv) model as a submodule.
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.
99

1010
# Building
1111

12-
The easiest way to use this emulator is to use the dev container for the [CHERIoT RTOS](http://github.com/microsoft/cheriot-rtos).
12+
The easiest way to use the emulator is to use the dev container for the [CHERIoT RTOS](http://github.com/microsoft/cheriot-rtos).
1313

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

0 commit comments

Comments
 (0)