Skip to content

Files

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Oct 26, 2020
Sep 1, 2020

Generated Documentation

This directory contains documentation on the code within this repository. Documents can either be written directly in markdown, or use embedded mdoc, which compiles against the Rocket Chip (and dependencies) codebase as part of the PR CI checks, forcing the documentation to remain current with the codebase.

The src folder contains the source from which these are generated. To generate the documentation, run docs/mdoc from SBT, making sure that SBT is running from this repository's root directory. The generated documents will appear in the generated folder.