aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPrashanth Mundkur <prashanth.mundkur@gmail.com>2019-01-29 17:23:07 -0800
committerPrashanth Mundkur <prashanth.mundkur@gmail.com>2019-01-29 17:39:06 -0800
commit87a3fb8d444f7bd6fcb4eebb122f1ebe2a86eed8 (patch)
tree45abad22c0ae2345c15ff55010aef84a7a33855c /README.md
parent8ca6b0996afc86f8ab7d898546e87a941b0c18b9 (diff)
downloadsail-riscv-87a3fb8d444f7bd6fcb4eebb122f1ebe2a86eed8.zip
sail-riscv-87a3fb8d444f7bd6fcb4eebb122f1ebe2a86eed8.tar.gz
sail-riscv-87a3fb8d444f7bd6fcb4eebb122f1ebe2a86eed8.tar.bz2
Update docs, and fix file names.
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 5 insertions, 23 deletions
diff --git a/README.md b/README.md
index 7cb4d7e..26efe91 100644
--- a/README.md
+++ b/README.md
@@ -40,30 +40,12 @@ sail-riscv
+---- riscv-tests // snapshot of tests from the riscv/riscv-tests github repo
```
-An outline of the specification
--------------------------------
-
-The model contains the following Sail modules in the `model` directory:
-
-- `prelude.sail` contains useful Sail library functions
-
-- `riscv_types.sail` contains some basic RISC-V definitions
-
-- `riscv_sys.sail` describes M-mode and S-mode CSRs and exception handling
-
-- `riscv_platform.sail` contains platform-specific functionality
- (e.g. physical memory map and clock and terminal device interfaces)
-
-- `riscv_mem.sail` contains the interface to physical memory
-
-- `riscv_vmem.sail` describes the S-mode address translation
-
-- `riscv.sail` captures the instruction definitions and their assembly language formats
-
-- `riscv_step.sail` implements the top-level fetch and execute loop
-
-- `riscv_analysis.sail` is used in the formal operational RVWMO memory model
+Documentation
+-------------
+A [reading guide](doc/ReadingGuide.md) to the model is provided in the
+[doc/](doc/) subdirectory, along with a guide on [how to
+extend](doc/ExtendingGuide.md) the model.
Simulators
----------