lowRISC / lowRISC/opentitan

[doc] Mention that at least the Vivado Lab Edition is needed to build SW

Open
#18,482 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component:Doc Earlgrey-PROD Triaged Priority:P2
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

### Description

The [getting started guide](https://opentitan.org/guides/getting_started/index.html) (the flow chart in particular) seems to indicate that for building SW no EDA tools need to be installed. However, it turns out that at least the `Lab Edition` of Xilinx Vivado is needed in order to splice ROM images. This info is buried in the Vivado installation guide [here](https://opentitan.org/guides/getting_started/install_vivado/index.html). It would be helpful to add a note to the main getting started guide to point this out.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the getting started guide, especially its flow chart, and compare it with the linked Vivado installation guide. Add a note explaining that at least the Vivado Lab Edition is required to splice ROM images when building software, then verify the main guide clearly points readers to the installation requirements.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.