diff --git a/hpvm/test/README.md b/hpvm/test/README.md index 175d60ea63bdd8c428d3ec4d67d9329c7493322b..801af4c15a1832a467511804527e4e70043eb3df 100644 --- a/hpvm/test/README.md +++ b/hpvm/test/README.md @@ -1,4 +1,4 @@ -#Test Directory Organization +# Test Directory Organization The test directory is organized as follows: * unitTests: Includes unit tests for HPVM. * regressionTests: Includes regression tests for HPVM. diff --git a/hpvm/test/benchmarks/README.md b/hpvm/test/benchmarks/README.md new file mode 100644 index 0000000000000000000000000000000000000000..0f227a2c34e815e80aeb03f4fc0090940a536517 --- /dev/null +++ b/hpvm/test/benchmarks/README.md @@ -0,0 +1,20 @@ +# Using HPVM +The below benchmarks are provided with HPVM, along with a template Makefile for user projects. + +In order to be able to build the existing benchmarks, a new `Makefile.config` must be created in [include](/hpvm/test/benchmarks/include) based on the existing `Makefile.config.example`. This configuration file must set up the following paths: +* LLVM_BUILD_DIR: should point to your local `build` directory of HPVM. +* HPVM_BENCH_DIR: should point to this benchmakrs directory. +* CUDA_PATH: should point to your local CUDA installation. + +## Parboil +Instructions to compile and run Parboil are provided in the following [README](/hpvm/test/benchmarks/parboil). + +## Harvard Camera Pipeline (HPVM-CAVA) +Instructions to compile and run HPVM-CAVA are provided in the following [README](/hpvm/test/benchmarks/hpvm-cava). + +## Edge Detection Pipeline +Instructions to compile and run Pipeline are provided in the following [README](/hpvm/test/benchmarks/pipeline). + +## Your own project +See `template/` for an example Makefile and config. +Include `hpvm.h` to use HPVM C api functions, found in the `include/hpvm.h`.