Skip to content

Commit

Permalink
Change README links to reflect repo moves
Browse files Browse the repository at this point in the history
  • Loading branch information
rmn30 authored Jul 31, 2024
1 parent 21ff25b commit b2c45c2
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

This repository contains the specification for the [CHERIoT](https://cheriot.org) ISA.
It consists of a document written in [latex](/archdoc) which includes excerpts of the [reference model](/src) written in [Sail](http://github.com/rems-project/sail).
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/).
The Sail code is used to build an instruction set simulator which is included in the [CHERIoT RTOS dev container](https://github.com/microsoft/cheriot-rtos/blob/main/docs/GettingStarted.md).
The [current draft architecture document](https://cheriot.org/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/CHERIoT-Platform/cheriot-rtos/).
The Sail code is used to build an instruction set simulator which is included in the [CHERIoT RTOS dev container](https://github.com/CHERIoT-Platform/cheriot-rtos/blob/main/docs/GettingStarted.md).
It can also be used to prove [properties](properties) of the ISA using Sail's SMT support.

The architecture is based on the [CHERI specification](https://github.com/CTSRD-CHERI/cheri-specification).
The code is derived 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.

# Building

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).
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/CHERIoT-Platform/cheriot-rtos/blob/main/docs/GettingStarted.md).

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

Expand All @@ -25,7 +25,7 @@ opam install sail
Then clone the repo:

```
git clone --recurse-submodules https://github.com/microsoft/cheriot-sail
git clone --recurse-submodules https://github.com/CHERIoT-Platform/cheriot-sail
cd cheriot-sail
```

Expand Down

0 comments on commit b2c45c2

Please sign in to comment.