search

riscv-non-isa / tg-nexus-trace

RISC-V Nexus Trace TG documentation and reference code
https://jira.riscv.org/browse/RVG-96
Creative Commons Attribution 4.0 International
43 stars 32 forks source link

Adopt the RISC-V documentation format #7

Closed jjscheel closed 11 months 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

FYI, I'm working through a bug in the automated build before I submit the PR. I figured you might want that too...

Hope to submit before EOW.

jjscheel commented 2 years ago

Problem resolved and PR submitted yesterday.