diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index e9d87b01..fe9626ca 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -51,8 +51,18 @@ jobs: run: mkdir -p _site/example_cfg - name: Create _site/manual run: mkdir -p _site/manual + - name: Create _site/pdfs + run: mkdir -p _site/pdfs - name: Copy cfg html run: cp -R gen/cfg_html_doc/generic_rv64/html _site/example_cfg + - name: Create RVA Family PDF Spec + run: ./do gen:profile_pdf[MC-1] + - name: Copy RVA Family PDF + run: cp gen/profile_doc/pdf/rva.pdf _site/pdfs/rva.pdf + - name: Create MC-1 PDF Spec + run: ./do gen:csc_crd_pdf[MC-1] + - name: Copy MC-1 PDF + run: cp gen/csc_crd_doc/pdf/MC-1.pdf _site/pdfs/MC-1.pdf - name: Copy manual html run: cp -R gen/manual/isa/top/all/html _site/manual - name: Setup Pages diff --git a/README.adoc b/README.adoc index 70151f55..6f143e3e 100644 --- a/README.adoc +++ b/README.adoc @@ -1,5 +1,17 @@ = RISC-V Unified Database +== Generated artifacts + +The following artifacts have been generated from the top of the `main` branch: + +* https://riscv-software-src.github.io/riscv-unified-db/manual/html/index.html[ISA Manual with instruction and CSR appendix] +* https://riscv-software-src.github.io/riscv-unified-db/example_cfg/html/index.html[configuration-specific documentation] +* https://riscv-software-src.github.io/riscv-unified-db/ruby/index.html[Ruby API documentation (database interface)] +* https://riscv-software-src.github.io/riscv-unified-db/pdfs/rva.pdf[RVA Profile Family] +* https://riscv-software-src.github.io/riscv-unified-db/pdfs/MC-1.pdf[MC-1 Certification Requirements Document] + +== Overview + The RISC-V Unified Database is intended to hold *all* the information needed to describe RISC-V, including a list of extensions, instruction specifications, CSR specifications, and documentation prose. The vision is that anything one would need for RISC-V can be generated from the information in this repository. @@ -88,8 +100,8 @@ Quick start: ./do --tasks # list all documented tasks # examples -./do gen:arch[generic_rv64] # generate arch spec for the 'generic_rv64' config ./do validate # validate against the schema +./do gen:arch[generic_rv64] # generate arch spec for the 'generic_rv64' config ---- == More info