Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RVA/MC-1 pdf generation to GitHub actions, link off README #47

Merged
merged 2 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 13 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
Expand Down
Loading