Skip to content

Commit 2ea674f

Browse files
authored
Update README.md library integration instructions (#91)
1 parent f60cfa8 commit 2ea674f

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,30 @@ you acknowledge that you accept terms specified in the [LICENSE.md](LICENSE.md)
2626
# Building
2727

2828
The library is designed to be embedded into existing CMake build process. Clone the GitHub
29-
repository and add it as a subdirectory to your CMakeLists.txt. A single library target, called
30-
`hwcpipe`, is made available for you to link to your project.
29+
repository and add it as a subdirectory to your `CMakeLists.txt`. The build generates two
30+
libraries:
3131

32-
For example, your `CMakeLists.txt` could contain:
32+
* `device` is the low-level hardware sampling backend.
33+
* `hwcpipe` is the high-level query and sampling frontend.
3334

34-
```
35-
add_subdirectory(external/hwcpipe)
36-
target_link_libraries(my_project hwcpipe)
35+
You will need to include both libraries in your application link step. For example, your
36+
`CMakeLists.txt` could contain:
37+
38+
```cmake
39+
add_subdirectory(path/to/libGPUCounters)
40+
41+
target_link_libraries(
42+
my_project
43+
device
44+
hwcpipe)
3745
```
3846

3947
## Building the example
4048

4149
A small example demonstrating the API usage is provided in the `examples` folder. To build the
4250
example enable the `HWCPIPE_BUILD_EXAMPLES` CMake build option.
4351

44-
```
52+
```sh
4553
cmake -DHWCPIPE_BUILD_EXAMPLES=ON -B build .
4654
```
4755

@@ -52,7 +60,6 @@ If you have issues with the library itself, please raise them in the project's G
5260
If you have any questions about Arm GPUs, application development for Arm GPUs, or general mobile
5361
graphics development or technology please submit them on the [Arm Community graphics forums][1].
5462

55-
5663
- - -
5764

5865
_Copyright © 2023-2025, Arm Limited and contributors. All rights reserved._

0 commit comments

Comments
 (0)