11 lines
598 B
Markdown
11 lines
598 B
Markdown
# 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. |