summaryrefslogtreecommitdiff
path: root/docs/user-guide/01-get-started.md
diff options
context:
space:
mode:
authorGangzheng Tong <gtong@nvidia.com>2025-04-11 15:34:07 -0700
committerGitHub <noreply@github.com>2025-04-11 22:34:07 +0000
commit8e6af6259bd1dd47d81c36f0562ff362ca5d42c3 (patch)
tree86e7a9671dae748922ca18eec544a318cd708443 /docs/user-guide/01-get-started.md
parent61a6c211b1587a7b9ed6a24ae1ba6fe0600c80d8 (diff)
Fix user-guide typos (#6789)
* Fix user-guide typos Use LLM to scan each of the markdown files to fix typos. Try not to change anything but the typos in this CL. * typo not caught by LLM * add output of ./build_toc.ps1
Diffstat (limited to 'docs/user-guide/01-get-started.md')
-rw-r--r--docs/user-guide/01-get-started.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/user-guide/01-get-started.md b/docs/user-guide/01-get-started.md
index 7868b4221..fce4e6644 100644
--- a/docs/user-guide/01-get-started.md
+++ b/docs/user-guide/01-get-started.md
@@ -5,11 +5,11 @@ permalink: /user-guide/get-started
# Getting Started with Slang
-Slang enables you to do many powerful things with shader code, including compiling shader code to many different platforms, obtaining reflection information, organizing your shader library in a modern modular fashion, controlling specialization and more. The following sections help you getting started with the basics of Slang in a simple example. We will assume Windows as the operating system, but the steps performed here are similar for other platforms.
+Slang enables you to do many powerful things with shader code, including compiling shader code to many different platforms, obtaining reflection information, organizing your shader library in a modern modular fashion, controlling specialization and more. The following sections help you get started with the basics of Slang in a simple example. We will assume Windows as the operating system, but the steps performed here are similar for other platforms.
## Installation
-The easiest way to start using Slang is to download a [binary release](https://github.com/shader-slang/slang/releases/) from the github repository. Once you have downloaded and extracted the files from a release package, you can find the `slangc.exe` executable under `/bin/windows-x64/release/`. In this tutorial we will use the `slangc` standalone Slang compiler included in a release package. Note that `slang.dll` and `slang-glslang.dll` must be placed in the same directory as `slangc.exe` as they are required by the standalone executable.
+The easiest way to start using Slang is to download a [binary release](https://github.com/shader-slang/slang/releases/) from the GitHub repository. Once you have downloaded and extracted the files from a release package, you can find the `slangc.exe` executable under `/bin/windows-x64/release/`. In this tutorial we will use the `slangc` standalone Slang compiler included in a release package. Note that `slang.dll` and `slang-glslang.dll` must be placed in the same directory as `slangc.exe` as they are required by the standalone executable.
If you are interested in building from source, please refer to the [documentation on building Slang](../building.md).
@@ -99,4 +99,4 @@ Note that in the generated GLSL code, all shader parameters are qualified with e
## The full example
-The full Vulkan example that sets up and runs the `hello-world.slang` shader in located in the [/examples/hello-world](https://github.com/shader-slang/slang/tree/master/examples/hello-world) directory of the Slang repository. The example code initializes a Vulkan context and runs the compiled SPIRV code. The example code demonstrates how to use the Slang API to load and compile shaders.
+The full Vulkan example that sets up and runs the `hello-world.slang` shader is located in the [/examples/hello-world](https://github.com/shader-slang/slang/tree/master/examples/hello-world) directory of the Slang repository. The example code initializes a Vulkan context and runs the compiled SPIRV code. The example code demonstrates how to use the Slang API to load and compile shaders.