Skip to content

Commit 24bf067

Browse files
cheneym2csyonghe
andauthored
Increase slangc option visibility in docs (shader-slang#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 shader-slang#4124 * Update README.md * Update 08-compiling.md --------- Co-authored-by: Yong He <yonghe@outlook.com>
1 parent 6367d40 commit 24bf067

File tree

5 files changed

+280
-223
lines changed

5 files changed

+280
-223
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ Slang binaries are also included in the [Vulkan SDK](https://vulkan.lunarg.com/s
5353
There are packages built for 32- and 64-bit Windows, as well as 64-bit Ubuntu.
5454
Each binary release includes the command-line `slangc` compiler, a shared library for the compiler, and the `slang.h` header.
5555

56+
See the user-guide for info on using the `slangc` command-line tool: [Slang Command Line Usage](
57+
https://shader-slang.com/slang/user-guide/compiling.html#command-line-compilation-with-slangc).
58+
5659
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.
5760

5861
If you would like to build Slang from source, please consult the [build instructions](docs/building.md).

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Getting Started
99

1010
The Slang [User's Guide](https://shader-slang.github.io/slang/user-guide/) provides an introduction to the Slang language and its major features, as well as the compilation and reflection API.
1111

12-
There is also documentation specific to using the [`slangc`](command-line-slangc.md) command-line tool.
12+
There is also documentation specific to using the [slangc](https://shader-slang.github.io/slang/user-guide/compiling.html#command-line-compilation-with-slangc) command-line tool.
1313

1414
Advanced Users
1515
--------------

docs/command-line-slangc.md

-209
This file was deleted.

docs/nvapi-support.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The astute reader may have noticed that the default Slang HLSL prelude *does* co
6363
#endif
6464
```
6565

66-
This means that the *downstream* compiler (such as DXC and FXC) must be able to handle this include. Include paths can be specified for downstream compilers via the [-X mechanism](command-line-slangc.md#downstream-arguments). So for example...
66+
This means that the *downstream* compiler (such as DXC and FXC) must be able to handle this include. Include paths can be specified for downstream compilers via the [-X mechanism](user-guide/08-compiling.md#downstream-arguments). So for example...
6767

6868
```
6969
-Xfxc -IpathTo/nvapi -Xdxc -IpathTo/nvapi

0 commit comments

Comments
 (0)