From 510757beda977cb8fe8a06abdb00b67a3f669ecb Mon Sep 17 00:00:00 2001
From: Prakalp Srivastava <psrivas2@illinois.edu>
Date: Sat, 23 Dec 2017 13:39:50 -0600
Subject: [PATCH] Update README.md

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 42 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 1c9fda781f..cc8891b8b4 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
-# HPVM
+# Heterogeneous Parallel Virtual Machine
+
+This repository contains miscellaneous supporting materals for HPVM.
+
+## Paper
+
+[Technical Report](https://arxiv.org/abs/1611.00860)
 
 ## Dependencies
 You would need to download and install the following components for using AVX and NVIDIA GPUs to speed up your programs
@@ -14,13 +20,45 @@ cd llvm/projects
 git clone https://github.com/llvm-mirror/compiler-rt
 git checkout release_40
 cd ../..
+```
 
-# Switch to 4.0 branch
+Switch to 4.0 branch
+```shell
 git checkout update_llvm4
+```
 
-# Build
+Build hpvm
+```shell
 mkdir install
 mkdir build && cd build
 cmake ../llvm -DCMAKE_BUILD_TYPE=Debug -DLLVM_TARGETS_TO_BUILD="X86;NVPTX" -DCMAKE_INSTALL_PREFIX=../install
 make -j<number of threads you want to use to build hpvm>
-```
\ No newline at end of file
+```
+
+Build hpvm runtime 
+```shell
+cd projects/visc-rt
+make
+cd ..
+```
+To use hpvm to compile benchmarks set environment variable `LLVM_SRC_ROOT` to llvm directory in your local repository
+```shell
+export LLVM_SRC_ROOT=<full path to hpvm>/llvm
+```
+
+### Benchmark Suites
+
+Benchmark suites have been migrated to the LLVM 4.0 build. They are located
+in [VISC](/llvm/test/VISC/parboil/benchmarks).
+
+### Running an example (sgemm in parboil)
+```shell
+cd llvm/test/VISC/parboil/benchmarks/sgemm
+make 
+make run
+```
+
+### Other Old Components
+
+Search this repository for "visc", case-insensitive.
+
-- 
GitLab