Created initial README.md
Change-Id: Ic799939d918b1b037ece1bc434a4e0abc5a39e97
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
diff --git a/src/hei_user_interface.hpp b/src/hei_user_interface.hpp
index b7dd092..30e869d 100644
--- a/src/hei_user_interface.hpp
+++ b/src/hei_user_interface.hpp
@@ -1,10 +1,33 @@
#pragma once
-// This header provides access to headers and macros defined by the user
-// application.
-#include <hei_trace.hpp>
+// The user application must define this header file with the following macros:
+//
+// Tracing (inputs same as printf() from <cstdio>):
+// HEI_INF( ... ) // Generic informational trace
+// HEI_ERR( ... ) // Error path trace
+//
+// Assertion (at a minimum should work like assert() from <cassert>):
+// HEI_ASSERT( expression )
+//
+#include <hei_user_defines.hpp>
-// The rest of this header contains interfaces that the user application must
-// define.
+namespace libhei
+{
+
+/**
+ * @brief Perform a hardware read operation.
+ */
+void deviceRead();
+
+#ifndef __HEI_READ_ONLY
+
+/**
+ * @brief Perform a hardware write operation.
+ */
+void deviceWrite();
+
+#endif
+
+} // end namespace libhei