Skip to content

Commit c7ded76

Browse files
Adding note on CMake convenience script (#3139)
* Adding note on convenience script * Addressing feedback * Update README.md reword --------- Co-authored-by: Max Podkorytov <[email protected]>
1 parent 507d81c commit c7ded76

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,44 @@ Docker images are available on [DockerHub](https://hub.docker.com/r/rocm/composa
9393
want to build the library for a list of different architectures,
9494
you should use the `GPU_ARCHS` build argument, for example `GPU_ARCHS=gfx908;gfx1030;gfx1100;gfx942`.
9595
96-
4. Build the entire CK library:
96+
**Convenience script for development builds:**
97+
98+
Alternatively, you can use the provided convenience script `script/cmake-ck-dev.sh` which automatically
99+
configures CK for development with sensible defaults. In the build directory:
100+
101+
```bash
102+
../script/cmake-ck-dev.sh
103+
```
104+
105+
This script:
106+
* Cleans CMake cache files before configuring
107+
* Sets `BUILD_DEV=ON` for development mode
108+
* Defaults to GPU targets: `gfx908;gfx90a;gfx942`
109+
* Enables verbose makefile output
110+
* Sets additional compiler flags for better error messages
111+
112+
By default, it considers the parent directory to be the project source directory.
113+
114+
You can specify the source directory as the first argument.
115+
You can specify custom GPU targets (semicolon-separated) as the second argument:
116+
117+
```bash
118+
../script/cmake-ck-dev.sh .. gfx1100
119+
```
120+
121+
Or pass additional cmake arguments:
122+
123+
```bash
124+
../script/cmake-ck-dev.sh .. gfx90a -DCMAKE_BUILD_TYPE=Release
125+
```
126+
127+
5. Build the entire CK library:
97128
98129
```bash
99130
make -j"$(nproc)"
100131
```
101132
102-
5. Install CK:
133+
6. Install CK:
103134
104135
```bash
105136
make -j install

0 commit comments

Comments
 (0)