From 36461aa958051c7114dd199fc8339a2a3c086e56 Mon Sep 17 00:00:00 2001
From: akashk4 <akashk4@illinois.edu>
Date: Fri, 31 Jan 2020 16:03:55 -0600
Subject: [PATCH] Add readme for hpvm-config

---
 hpvm/tools/README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 hpvm/tools/README.md

diff --git a/hpvm/tools/README.md b/hpvm/tools/README.md
new file mode 100644
index 0000000000..3fb84852b9
--- /dev/null
+++ b/hpvm/tools/README.md
@@ -0,0 +1,65 @@
+## hpvm-config -- Print HPVM compilation options
+
+### Synopsis
+hpvm-config option [components…]
+
+### Description
+hpvm-config print the compiler flags, linker flags and object libraries needed to link against HPVM.
+In addtion to printing flags printed by [llvm-config](http://llvm.org/docs/CommandGuide/llvm-config.html), hpvm-config also prints HPVM version and compiler
+flags required to compile HPVM programs.
+
+### Options
+–version
+    Print the version number of HPVM.
+
+-help
+    Print a summary of llvm-config arguments.
+
+–prefix
+    Print the installation prefix for HPVM.
+
+–src-root
+    Print the source root from which HPVM was built.
+
+–obj-root
+    Print the object root used to build HPVM.
+
+–bindir
+    Print the installation directory for HPVM binaries.
+
+–includedir
+    Print the installation directory for LLVM headers.
+
+–libdir
+    Print the installation directory for LLVM libraries.
+
+–cxxflags
+    Print the C++ compiler flags needed to use LLVM headers.
+
+–ldflags
+    Print the flags needed to link against LLVM libraries.
+
+–libs
+    Print all the libraries needed to link against the specified LLVM components, including any dependencies.
+
+–libnames
+    Similar to –libs, but prints the bare filenames of the libraries without -l or pathnames. Useful for linking against a not-yet-installed copy of LLVM.
+
+–libfiles
+    Similar to –libs, but print the full path to each library file. This is useful when creating makefile dependencies, to ensure that a tool is relinked if any library it uses changes.
+
+–components
+    Print all valid component names.
+
+–targets-built
+    Print the component names for all targets supported by this copy of LLVM.
+
+–build-mode
+    Print the build mode used when LLVM was built (e.g. Debug or Release)
+    
+### Exit Status
+If hpvm-config succeeds, it will exit with 0. Otherwise, if an error occurs, it will exit with a non-zero value.
+
+
+
+
-- 
GitLab