summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYong He <yonghe@outlook.com>2021-03-30 12:24:39 -0700
committerGitHub <noreply@github.com>2021-03-30 12:24:39 -0700
commitc9ce5b93ee5422c086ac3d01d14b2af6eab096ba (patch)
treed1e0e13ebc95a6a2bfd714fc0b784574178e14fc
parentae73d50d873079005734beb6b3e730c341485586 (diff)
Update README.md
-rw-r--r--docs/user-guide/README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
index f4e938c3d..8378f1bf8 100644
--- a/docs/user-guide/README.md
+++ b/docs/user-guide/README.md
@@ -1,3 +1,6 @@
+Slang User Guide
+------------------
+
Welcome to the Slang User's Guide, an introduction to the Slang language, compiler, and API. In this guide, you will learn:
- Slang's language features, including those inherited from HLSL and additional language features to make it easy to work with shaders.
- The compiler API that controls how to assemble shaders from different pieces of code, and how they are compiled for different targets.
@@ -7,7 +10,7 @@ Welcome to the Slang User's Guide, an introduction to the Slang language, compil
Table of Contents
----------------
1. [Introduction](00-introduction.md)
-2. [Getting Started](01-getting-started.md)
+2. [Getting Started](01-get-started.md)
3. [Conventional Language Features](02-conventional-features.md)
4. [Extended language features](03-convenience-features.md)
5. [Interfaces and Generics](04-interfaces-generics.md)