Skip to content

Commit

Permalink
Update README to include instruction to fetch git tags
Browse files Browse the repository at this point in the history
Also, slight reformatting.

Change-Id: I7c35343556e48cadccd266b41465fb5ea04ace29
  • Loading branch information
Chris Freehill authored and Chris Freehill committed Dec 9, 2019
1 parent 2afaae2 commit 831f3ab
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ ROCm Application for Reporting System Info
## To Build
Use the standard cmake build procedure to build rocminfo. The location of ROCM
root (parent directory containing ROCM headers and libraries) must be provided
as a cmake argument using the standard CMAKE_PREFIX_PATH cmake variable. Building
the package also requires the rocm-cmake helper files.
as a cmake argument using the standard CMAKE_PREFIX_PATH cmake variable.

For example, building from the CMakeLists.txt directory
might look like this:
After cloning the rocminfo git repo, please make sure to do a git-fetch --tags
to get the tags residing on the repo. These tags are used for versioning.
For example,

$ git fetch --tags origin

Building from the CMakeLists.txt directory might look like this:

mkdir -p build

Expand All @@ -20,6 +24,6 @@ make

cd ..


Upon a successful build the binary, rocminfo, and the python script, rocm_agent_enumerator, will be in the build folder.
Upon a successful build the binary, rocminfo, and the python script,
rocm_agent_enumerator, will be in the build folder.

0 comments on commit 831f3ab

Please sign in to comment.