From 831f3ab124233877087812384c56e19a0198f022 Mon Sep 17 00:00:00 2001 From: Chris Freehill Date: Mon, 9 Dec 2019 14:51:53 -0600 Subject: [PATCH] Update README to include instruction to fetch git tags Also, slight reformatting. Change-Id: I7c35343556e48cadccd266b41465fb5ea04ace29 --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7e6e12828b..74e840b51b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.