Skip to content

Commit c4c4463

Browse files
committed
Fix deprecated documentation in README
1 parent 3f5b688 commit c4c4463

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,27 @@ Install ROCm in the default directory under `/opt` following the [ROCm documenta
3131
## Versioning Scheme
3232

3333
The crates in this repository follow the versioning conventions outlined below:
34-
- The default supported ROCm version of the crates is used as the base version.
35-
- The patch version of the ROCm release is multiplied by 1000, allowing multiple revisions of a crate that defaults to the same ROCm version.
34+
- The latest supported ROCm version of the crates is used as the base version.
35+
- The patch version of the ROCm release is multiplied by 1000, allowing multiple revisions of a crate for the same ROCm version.
3636

3737
### Example:
3838

39-
The `cubecl-hip-sys` version `6.2.4000` represents the first release with ROCm `6.2.4` as the default.
40-
If a fix is required and the default ROCm version remains `6.2.4`, the `cubecl-hip-sys` version is incremented to `6.2.4001`.
39+
The `cubecl-hip-sys` version `6.2.4000` represents the first release with ROCm `6.2.4`.
40+
If a fix is required and the ROCm version remains `6.2.4`, the `cubecl-hip-sys` version is incremented to `6.2.4001`.
4141

4242
## Usage
4343

44-
Add the crate [cubecl-hip-sys][2] to the `Cargo.toml` of your project and enable the feature
44+
Add the crate [cubecl-hip-sys][2] to the `Cargo.toml` file of your project and enable the feature
4545
corresponding to the version of ROCm you have installed.
4646

47+
If no feature is provided then the build script will attempt to find the default ROCm version installed on your system.
48+
Read the `warning` messages in the build output to learn about the script behavior.
49+
4750
```toml
4851
cubecl-hip-sys = { version = "6.3.1000", features = ["rocm__6_3_1"] }
4952
```
5053

51-
If no feature corresponds to your ROCm installation then read the next section to learn
54+
If you installed a newer ROCm version that is not yet supported by this crate then read the next section to learn
5255
how to generate and submit new bindings for your version.
5356

5457
Next you need to point out where you installed ROCm so that `rustc` can link to your ROCM libraries. To do so set the variable `ROCM_PATH`, or `HIP_PATH` or the more specific `CUBECL_ROCM_PATH` to its
@@ -75,11 +78,10 @@ Here is a table of the libraries covered by each crate:
7578
To run tests you need to first meet the expectations for both `Prerequisites` and `Usage`
7679
sections.
7780

78-
Then execute the following xtask command. If you want to test against a different version of
79-
ROCm than the default one, use the `-v <version>`, for instance `-v 6.2.2`:
81+
Then execute the following xtask command by providing the version of ROCm to test, for instance `-v 6.2.2`:
8082

8183
```sh
82-
# test default ROCm bindings
84+
# test ROCm bindings againt the system default ROCm installation if found
8385
cargo xtask test
8486
# test a specific version that is not the default
8587
cargo xtask test -v 6.2.2

0 commit comments

Comments
 (0)