summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoryum <yum.food.vr@gmail.com>2025-10-12 11:03:21 -0700
committeryum <yum.food.vr@gmail.com>2025-10-12 11:03:21 -0700
commitab1d5611ca733f73116910ca7190fb2d32ced10d (patch)
tree4a44706164281ab5b689cfe3a86b8323ae95afdb
parentfcdd7c9fcee17f1d44a1c46f29b0e83f6d0304c8 (diff)
update readme
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 83db378..9d6b6ae 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,9 @@ basics and gotchas
- all functions marked `public` are exported as entrypoints.
- we use a custom build of slang which lets entrypoints use regular arguments
instead of cbuffers / structs.
-- it should "just work" for simple math kernels
+- it is intended for use with simple math kernels
+ - see `example.slang` for an example. you'd `#include example.hlsl` in the
+ rest of some shader and call the public APIs.
usage