riscv-debug-spec icon indicating copy to clipboard operation
riscv-debug-spec copied to clipboard

Readme: Fix build instructions

Open JanMatCodasip opened this issue 1 year ago • 1 comments

The Readme still contained old (pre-adoc) build instructions. Fix it.

Mention also the use of submodules which are needed for the documentation to build.

JanMatCodasip avatar Oct 09 '24 06:10 JanMatCodasip

Hello @pdonahue-ventana -

I have checked .github/workflows/verify.yml and it is correct and consistent with the updated Readme. Still, I have slightly expanded the build instructions in Readme to provide a little more guidance to the user.

I have also looked at .github/workflows/publish.yml and you are correct, this job is definitely outdated:

I propose to remove it (in another merge request: https://github.com/riscv/riscv-debug-spec/pull/1078).

JanMatCodasip avatar Oct 21 '24 05:10 JanMatCodasip

@rtwfroody @pdonahue-ventana Could this PR be merged, please?

Thank you.

JanMatCodasip avatar Jan 08 '25 20:01 JanMatCodasip

@pdonahue-ventana Gentle ping, could this PR be merged, please?

JanMatCodasip avatar Feb 14 '25 12:02 JanMatCodasip