Reverts #1379 and properly migrates the docs (#1381)

Reverts #1379 and properly migrates the docs --------- Co-authored-by: Matt Williams <matt.williams@amd.com>
2025-10-15 20:18:27 +05:30
parent b6a187aed1
commit 946385d0ff
15 changed files with 0 additions and 0 deletions
@@ -0,0 +1,77 @@
+.. meta::
+  :description: AQLprofile installation process
+  :keywords: AQLprofile, ROCm, install
+
+******************
+Install AQLprofile
+******************
+
+Learn how to build AQLprofile with a script or with CMake, then install the library with a command.
+
+Prerequisites
+=============
+
+Before you begin, ensure these tools and dependencies are installed:
+
+* ROCm stack
+* ``rocm-llvm-dev`` (required to build tests)
+
+
+Build AQLprofile
+================
+
+You can build AQLprofile using either the provided build script (recommended for most users) or by manually invoking CMake for custom builds.
+
+
+Option 1: Use the build script (Recommended)
+--------------------------------------------
+
+This configures and builds the project with the default settings: 
+
+.. code:: bash 
+  
+  ./build.sh
+
+
+Option 2: Use CMake for custom builds
+-------------------------------------
+
+For more control over the build process, you can set the CMake options manually:
+
+.. code:: bash
+
+      # Set the CMAKE_PREFIX_PATH to point to hsa-runtime includes path and hsa-runtime library path
+      export CMAKE_PREFIX_PATH=<path to hsa-runtime includes>:<path to hsa-runtime library>
+      # For example, if ROCm is installed at /opt/rocm:
+      # export CMAKE_PREFIX_PATH=/opt/rocm/lib:/opt/rocm/include/hsa
+
+      export CMAKE_BUILD_TYPE=<debug|release> # release by default
+
+      cd /path/to/aqlprofile
+      mkdir build
+      cd build
+      cmake ..
+      make -j
+
+
+Enable debug tracing (Optional) 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To enable debug tracing, set this environment variable before running CMake: 
+
+.. code:: bash
+  
+  export CMAKE_DEBUG_TRACE=1
+
+This enables verbose debug output of the command packets while this library executes.
+
+
+Install the AQLprofile libraries
+================================
+
+Once your build is successful, install the AQLprofile libraries with:
+
+.. code:: bash
+
+    cd build
+    sudo make install