diff options
| author | Yong He <yonghe@outlook.com> | 2021-03-30 11:43:11 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-30 11:43:11 -0700 |
| commit | 2df2267ca687a64ec6b507aaa0ec572b4fd59432 (patch) | |
| tree | ea36ee736da0dba9c32a3473d0cc661e9d45dba5 /docs/user-guide | |
| parent | 488e7cd8d02bf9e1d37b3e76fad6cb5ced6d8878 (diff) | |
Update README.md
Diffstat (limited to 'docs/user-guide')
| -rw-r--r-- | docs/user-guide/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md index e69de29bb..f4e938c3d 100644 --- a/docs/user-guide/README.md +++ b/docs/user-guide/README.md @@ -0,0 +1,17 @@ +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.
+- The reflection API that allows the host application to query the details of shader code in order to generate the right shader kernel and to set shader parameters correctly.
+
+
+Table of Contents
+----------------
+1. [Introduction](00-introduction.md)
+2. [Getting Started](01-getting-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)
+6. [Compiling Code with Slang](05-compiling.md)
+7. [Supported Compilation Targets](06-targets.md)
+
+Note: this documentation is still under active development. While the coverage on language features is complete, we are still working on the remaining chapters on Slang's compilation and reflection API.
|