Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.3 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.3 KB
Raw

Documentation

Information on the specification and supplementary information.

This directory contains the official draft specification, in AsciiDoc form. The specification is split into two components: Scalar+Entropy Source and Vector.

To install the relevent tools for building a PDF document from the AsciiDoc source, follow the instructions here

  • Both specifications can be built by running:

    source bin/conf.sh
git submodule update --init extern/sail-riscv extern/riscv-opcodes
make specs

    from the root project of the directory.

    Note the git submodule command is needed, because Sail code is pulled directly from the source into the specification, so the files need to be checked out.

    Individual versions can be built by running:

    make -C doc/scalar all
make -C doc/vector all

  • Alternatively, pre-built versions corresponding to draft releases can be found on the releases page.

  • Supplementary information, in AsciiDoc format. This contains various recommendations, discussions and design rationale which we have developed in conjunction to the specification.