Skip to content

[doc] Improve dev guide#554

Merged
elliotb-lowrisc merged 1 commit into
lowRISC:mainfrom
elliotb-lowrisc:doc
May 18, 2026
Merged

[doc] Improve dev guide#554
elliotb-lowrisc merged 1 commit into
lowRISC:mainfrom
elliotb-lowrisc:doc

Conversation

@elliotb-lowrisc
Copy link
Copy Markdown
Contributor

Several updates and improvements to the dev guide:

  • Update out-of-date commands.
  • Add commands for running SW on FPGA.
  • Add options to Verilator build command to improve build/sim runtime.
  • Document temperature sensor connections.
  • Add some useful alternative commands.
  • Clarify the use of the "_sram" SW binary suffix.
  • Other minor textural improvements.

@elliotb-lowrisc
Copy link
Copy Markdown
Contributor Author

I intend to make this PR non-draft when I have had a chance to try the new FPGA commands

@elliotb-lowrisc elliotb-lowrisc linked an issue May 14, 2026 that may be closed by this pull request
@elliotb-lowrisc elliotb-lowrisc marked this pull request as ready for review May 15, 2026 13:07
Comment thread doc/ref/dev_guide.md Outdated
cmake --build build/sw -j $(nproc)
```

Outputs with the suffix "_sram" exist only for UVM-based tests, as they lack a DRAM backdoor-load mechanism.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm concern that this will be left behind when the _sram binaries are dropped.
If you wan't to keep this, please add item to the issue to clean up the documentation.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I didn't realise that they were going to go away. I've added the item to the issue

Comment thread doc/ref/dev_guide.md Outdated
Several updates and improvements to the dev guide:
- Update out-of-date commands.
- Add commands for running SW on FPGA.
- Add options to Verilator build command to improve build/sim runtime.
- Document temperature sensor connections.
- Add some useful alternative commands.
- Clarify the use of the "_sram" SW binary suffix.
- Other minor textural improvements.
Copy link
Copy Markdown
Collaborator

@engdoreis engdoreis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the documentation better.

@elliotb-lowrisc elliotb-lowrisc merged commit 99fe25a into lowRISC:main May 18, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Improve Developer Guide

2 participants