Add tests/README.md

tests/README.md

@@ -0,0 +1,28 @@
+# Tests
+This directory contains the input RISC-V files for various tests.
+
+## Contents
+
+### failing.txt
+A list of tests that are known to fail under the current implementation. Each line consists of a single path to a failing test file. Paths are given relative to the `riscv-semantics` repository root.
+
+### riscv-arch-test / riscv-arch-test-compiled
+The official RISC-V Architectural Test Suite. These are exercised in `src/tests/integration/test_conformance.py` as part of `make test_integration`.
+
+The test source files can be found under `riscv-arch-test/riscv-test-suite` and compiled by calling `make tests/riscv-arch-test-compiled` from the repository root. This will populate the `riscv-arch-test-compiled` directory with the following contents:
+- `database.yaml`
+  - A database of all tests in the suite with associated information pulled from `RVTEST` macros.
+- `test_list.yaml`
+  - A list of selected tests to run based on the supported ISA and platform in `kriscv_isa_checked.yaml` and `kriscv_platform_checked.yaml`.
+- `kriscv_isa_checked.yaml`
+  - Completion of `src/tests/integration/riscof/kriscv/kriscv_isa.yaml`, checked for well-formedness and with all defaults made explicit.
+- kriscv_platform_checked.yaml
+  - Completion of `src/tests/integration/riscof/kriscv/kriscv_platform.yaml`, checked for well-formedness with all defaults made explicit.
+- Makefile.DUT-kriscv
+  - The generated Makefile which was used to compile the test suite.
+- rv(32|64)(i|e)_...
+  - The actual compiled test files for input to `kriscv`
+  - The directory structure mirrors `riscv-arch-test/riscv-test-suite`, but with each `<test_name>.S` test file replaced by a directory of the same name containing:
+      - `<test_name>.s`, the pre-linking RISC-V ASM
+	  - `<test_name>.elf`, the fully compiled object file
+	  - `<test_name>.disass`, the disassembly of the compiled object file