summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorcheneym2 <acheney@nvidia.com>2024-10-29 15:16:20 -0400
committerGitHub <noreply@github.com>2024-10-29 12:16:20 -0700
commit24bf067d4cb4868d4b733c2a646e0721e8b34ff8 (patch)
tree50d5da53db910f63d940da2c70e2f5e74a097f78 /README.md
parent6367d40aeecac0894ec291ef1aa6c43956b25345 (diff)
Increase slangc option visibility in docs (#5425)
* Increase slangc option visibility in docs Link to slangc command-line reference from readme. readme. Boost the visiblity of the link in the user-guide. Consolidates command-line-slangc.md into the user-guide. Fixes #4124 * Update README.md * Update 08-compiling.md --------- Co-authored-by: Yong He <yonghe@outlook.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 20e4f8d6b..c9d24da76 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,9 @@ Slang binaries are also included in the [Vulkan SDK](https://vulkan.lunarg.com/s
There are packages built for 32- and 64-bit Windows, as well as 64-bit Ubuntu.
Each binary release includes the command-line `slangc` compiler, a shared library for the compiler, and the `slang.h` header.
+See the user-guide for info on using the `slangc` command-line tool: [Slang Command Line Usage](
+https://shader-slang.com/slang/user-guide/compiling.html#command-line-compilation-with-slangc).
+
If you want to try out the Slang language without installing anything, a fast and simple way is to use the [Slang Playground](https://shader-slang.com/slang-playground). The playground allows you to compile Slang code to a variety of targets, and even run some simple shaders directly within the browser. The playground loads Slang compiler to your browser and runs all compilation locally. No data will be sent to any servers.
If you would like to build Slang from source, please consult the [build instructions](docs/building.md).