Initial commit.

README.md

@@ -0,0 +1,21 @@
+# hdk grid api - holodeck foundation library
+
+This library provides the foundation for hdk, including core data structures, utilities, and interfaces that other components of the grid will build upon. It serves as the backbone of the system, enabling efficient management of holographic data and interactions.
+
+(TODO: Reword that last sentence)
+
+## Shared Struct Wrapper
+
+The `SharedPtrWrapper` class is a reference-counted wrapper for shared pointers to structures. It provides a mechanism to manage the lifetime of shared resources while allowing for efficient access and caching of shared pointers. The wrapper ensures that shared pointers are properly managed and that resources are released when no longer needed, preventing memory leaks and ensuring efficient memory usage.
+
+The `SharedPtrWrapper` instances should be able to be used interchangeably with the underlying raw pointers in other C API calls, while still benefiting from the reference counting and caching mechanisms provided by the wrapper.
+
+
+## TODO Abstract Event Dispatching
+
+Things to consider:
+
+- Define a point to register callbacks.
+- Support defining return type and arbitrary number of arguments for the callback.
+- Support, optionally, multiple callbacks for the same event.
+- Support disconnecting callbacks.