Skip to content

Small clarification of documentation for devs that build from source #1562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HereThereBeDragons merged 5 commits into from
Sep 29, 2025
Merged

Small clarification of documentation for devs that build from source #1562

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef835ed
add more clarification for devs that build from source
HereThereBeDragons Sep 17, 2025
3fbe621
delete unnecessary empty line
HereThereBeDragons Sep 23, 2025
be2a6ed
change requests
HereThereBeDragons Sep 23, 2025
afa1c7b
rephrase common issue note
HereThereBeDragons Sep 24, 2025
f8b4f62
switching bold to italic
HereThereBeDragons Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ instructions and configurations for alternatives.
> [installing from releases](#installing-from-releases) in supported
> configurations is often faster and easier.

> [!IMPORTANT]
> Frequent setup and building problems and their solutions can be found in section [Common Issues](docs/environment_setup_guide.md#common-issues).

### Setup - Ubuntu (24.04)

> [!TIP]
Expand Down Expand Up @@ -184,7 +187,10 @@ Further flags allow to build components with specific features enabled.

### CMake build usage

To build ROCm/HIP:
For workflows that demand frequent rebuilds, it is **recommended to build it with ccache** enabled to speed up the build.

@marbre marbre Sep 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we go with italic over bold font? LGTM otherwise.

See instructions in the next section for [Linux](#ccache-usage-on-linux) and [Windows](#ccache-usage-on-windows).

Otherwise, ROCm/HIP can be configured and build with just the following commands:

```bash
cmake -B build -GNinja . -DTHEROCK_AMDGPU_FAMILIES=gfx110X-dgpu
Expand Down
Loading