diff --git a/README.md b/README.md index 8c759b30af7af6812a69f524075d75e2dcba9b13..8cbc606da9d581de71d75eeef2cba293b2d3a74c 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,13 @@ You would need to download and install the following components for using AVX an Checkout HPVM: ```shell -* git clone https://gitlab.engr.illinois.edu/llvm/hpvm.git -* git checkout hpvm-reorg-9 (this step may not be needed once code is mirrored on Github) + git clone https://gitlab.engr.illinois.edu/llvm/hpvm.git + git checkout hpvm-reorg-9 (this step may not be needed once code is mirrored on Github) ``` HPVM installer script can be used to dowwnload, configure and build HPMV along with LLVM and other subprojects including Clang. ```shell -* bash install.sh + bash install.sh ``` Specifically, the HPVM installer downloads the LLVM, Clang, compiler-rt, libcxxabi and lld, copies HPVM source into llvm/tools and build the entire tree. LLVM C-Backend is also built as a part of HPVM and is currently used to perform @@ -30,21 +30,21 @@ code generation in OpenCL for GPUs. The script provides you with an option to ch Alternatively, CMake can be run manually. ```shell -* cd hpvm/build -* cmake ../llvm [options] + cd hpvm/build + cmake ../llvm [options] ``` Some common options that can be used with CMake are: -```shell -* -DCMAKE_INSTALL_PREFIX=directory +``` +-DCMAKE_INSTALL_PREFIX=directory ``` --- Specify for directory the full pathname of where you want the HPVM tools and libraries to be installed. -```shell +``` -DCMAKE_BUILD_TYPE=type ``` --- Valid options for type are Debug, Release, RelWithDebInfo, and MinSizeRel. Default is Debug. -```shell +``` -DLLVM_ENABLE_ASSERTIONS=On ``` --- Compile with assertion checks enabled (default is Yes for Debug builds, No for all other build types).