summaryrefslogtreecommitdiffstats
path: root/examples/cpu-com-example/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cpu-com-example/README.md')
-rw-r--r--examples/cpu-com-example/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/examples/cpu-com-example/README.md b/examples/cpu-com-example/README.md
new file mode 100644
index 000000000..a5e234d15
--- /dev/null
+++ b/examples/cpu-com-example/README.md
@@ -0,0 +1,8 @@
+Slang COM Example
+=================
+
+The goal of this example is to demonstrate Slang generating CPU code that can be communicated with via Common Object Model (COM) style interfaces.
+
+The `shader.slang` file contains Slang code that uses COM interfaces.
+
+The `main.cpp` file contains the C++ application code, showing how to use the Slang API to load and compile the shader code and communicate via interfaces.