riscvarchive / riscv-platform-specs

RISC-V Profiles and Platform Specification
Creative Commons Attribution 4.0 International
112 stars 39 forks source link

Adopt the RISC-V documentation format #73

Open jjscheel opened 2 years ago

jjscheel commented 2 years ago

This is a 3-step update for which I will be submitting a PR:

  1. Import of docs-resources project as a submodule.
  2. Updates to the Makefile to use more options on asciidoctor PDF build, including the RISC-V theme (.yml file) and the fonts directory.
  3. Updates to the main .adoc file to include more variables for the build and the logo for the title page

Once complete, the side-effect for anyone starting to use this repo locally will be that they'll need to learn to use Git Submodules. Plenty of useful information is here. But the key step is to issue a git submodule update --init after a new clone or the first pull after this PR.

At key points in the future, we may want to use the git submodule update to update to a new level because Submodules always "link" at a given commit level. (More discussion here as we work with this.)

If anyone has questions about the process, please free to let me know.

jjscheel commented 2 years ago

Thanks for merging, @kumarsankaran. I'll leave this open until you feel comfortable that we've addressed any issues with the change. Please close when you are ready.