aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPrashanth Mundkur <prashanth.mundkur@gmail.com>2019-05-29 18:03:20 -0700
committerGitHub <noreply@github.com>2019-05-29 18:03:20 -0700
commitc50121c11c017b28914b9ba22b532c40fe09e6c3 (patch)
treea3e8ebb67d246efcd6fa4cf4ed036da75de86442
parent65085e894d4affeb41b6758680ca1b265e92d14c (diff)
parentc31b4fee9bd9447e3a3a4cf0843337a48edad860 (diff)
downloadsail-riscv-c50121c11c017b28914b9ba22b532c40fe09e6c3.zip
sail-riscv-c50121c11c017b28914b9ba22b532c40fe09e6c3.tar.gz
sail-riscv-c50121c11c017b28914b9ba22b532c40fe09e6c3.tar.bz2
Merge pull request #8 from ccasin/doc-updates
Two small README updates.
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8ab9e6c..91a0ba3 100644
--- a/README.md
+++ b/README.md
@@ -65,8 +65,10 @@ Coq, Isabelle and HOL4.
Building the model
------------------
-Install Sail via Opam, or build Sail from source and have `SAIL_DIR` in
-your environment pointing to its top-level directory.
+Install Sail [via
+Opam](https://github.com/rems-project/sail/wiki/OPAMInstall), or build Sail
+from source and have `SAIL_DIR` in your environment pointing to its
+top-level directory.
```
$ make
@@ -103,7 +105,16 @@ corresponding prover libraries in the Sail directory
Executing test binaries
-----------------------
-The C and OCaml simulators can be used to execute small test binaries.
+The C and OCaml simulators can be used to execute small test binaries. The
+OCaml simulator depends on the Device Tree Compiler package, which can be
+installed in Ubuntu with:
+
+```
+$ sudo apt-get install device-tree-compiler
+```
+
+Then, you can run test binaries:
+
```
$ ./ocaml_emulator/riscv_ocaml_sim_<arch> <elf-file>