diff --git a/README.md b/README.md index 231eaa9..3b41aa7 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ 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). @@ -11,7 +11,7 @@ The code is derived from [sail-cheri-riscv](http://github.com/CTSRD-CHERI/sail-c # 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: @@ -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 ```