Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
slgth authored and ASintzoff committed Oct 25, 2024
1 parent 5b4ac69 commit 02050ec
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

CVA6 documentation is published as a Read the Docs documentation.
It can be generated by running `make` in this directory.
This generates all necessary sub-documents.

## Configuration-specific manuals

Expand All @@ -15,12 +16,11 @@ Some parts are stripped down or annotated to only include what's relevant for ea

These manuals can be manually generated with: `make -C 04_cv32a65x/riscv priv-html unpriv-html`.
Replace `04_cv32a65x` with the desired target.
Some of the files used in this documentation (`config.adoc`) are directly generated from the RTL.

### Design documentation

Design documentation describes the internal architecture of the CVA6 processor.

It can be manually generated with: `make -C 04_cv32a65x/design design-html`.

Some of the files used in this documentation (`port_*.adoc`) are directly generated from the RTL.
They can be updated generated by running `python3 scripts/spec_builder.py`.
Some of the files used in this documentation (`config.adoc`, `parameters.adoc`, `port_*.adoc`, `csr.adoc`, `isa.adoc`) are directly generated from the RTL.

0 comments on commit 02050ec

Please sign in to comment.