summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorShannon Woods <158105547+swoods-nv@users.noreply.github.com>2024-03-27 13:54:00 -0400
committerGitHub <noreply@github.com>2024-03-27 10:54:00 -0700
commitc5369d507341e6b6fe64d4e6f26e194cd39235ca (patch)
treef43bc326eb4af2ca85b5cd1b1fdee241748cb26e /README.md
parentc37e3ee2a8523eea8873d77c3614ac963566921b (diff)
Update README.md with tables for platform & target support (#3847)
Adds tables to README.md for quick reference of which platforms and targets are supported. Links to detailed information in user guide. Bug Id: shader-slang/slang #3667
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5489041dd..3f774d88d 100644
--- a/README.md
+++ b/README.md
@@ -68,8 +68,20 @@ The following guidelines should be observed by contributors:
[Contribution guide](CONTRIBUTION.md) describes the workflow for contributors at more detail.
-Limitations
------------
+Limitations and Support
+-----------------------
+
+### Platform support
+| Windows | Linux | MacOS |
+|:---------------:|:--------------:|:------------:|
+| supported | supported | unofficial |
+
+### Target support
+| Direct3D 11 | Direct3D 12 | Vulkan | CUDA | OptiX | CPU Compute |
+|:---------------:|:--------------:|:---------------:|:-------------------:|:-----------:|:---------------------:|
+| HLSL | HLSL | GLSL & SPIR-V | C++ (compute-only) | C++ (WIP) | C++ (compute-only) |
+
+*for greater detail, see the [Supported Compilation Targets](https://shader-slang.com/slang/user-guide/targets.html) section of the [User Guide](https://shader-slang.github.io/slang/user-guide/)
The Slang project has been used for production applications and large shader codebases, but it is still under active development.
Support is currently focused on the platforms (Windows, Linux) and target APIs (Direct3D 12, Vulkan) where Slang is used most heavily.