summaryrefslogtreecommitdiff
path: root/examples/cpu-hello-world/README.md
diff options
context:
space:
mode:
authorjsmall-nvidia <jsmall@nvidia.com>2019-09-23 17:42:14 -0400
committerGitHub <noreply@github.com>2019-09-23 17:42:14 -0400
commitdc76577e2f1d851d6eb4963fa24d310d847b6786 (patch)
treee762a2fc22b36d585456e8345f2562cdcbea5fdc /examples/cpu-hello-world/README.md
parente9f0544aa4737d5cba8424f95485811b4839d76e (diff)
CPU Hello World (#1065)
* First pass on cpu-hello-world application. * Improvements to cpu-hello-world * Improved documentation around cpu-hello-world. Added information about C++/CPU targets to README.md Referenced cpu-target.
Diffstat (limited to 'examples/cpu-hello-world/README.md')
-rw-r--r--examples/cpu-hello-world/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/examples/cpu-hello-world/README.md b/examples/cpu-hello-world/README.md
new file mode 100644
index 000000000..32a8bf805
--- /dev/null
+++ b/examples/cpu-hello-world/README.md
@@ -0,0 +1,10 @@
+Slang "CPU Hello World" Example
+===============================
+
+The goal of this example is to demonstrate an almost minimal application that uses Slang to produce and use a kernel that is run on CPU.
+
+The `shader.slang` file contains a compute shader entry point. The shader code should compile as either Slang or HLSL code (that is, this example does not show off any new Slang language features).
+
+The `main.cpp` file contains the C++ application code, showing how to use the Slang API to load and compile the shader code to produce and execute CPU code.
+
+This example is not necessarily representative of best practices for integrating Slang into a production engine; the goal is merely to use the minimum amount of code possible to demonstrate a complete application that uses Slang.