From a0ef865ebe37fc3a9c747f3e2a9c1cf8c38c4bad Mon Sep 17 00:00:00 2001 From: Yong He Date: Tue, 30 Mar 2021 13:48:38 -0700 Subject: Rename README.md to index.md --- docs/user-guide/index.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/user-guide/index.md (limited to 'docs/user-guide/index.md') diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md new file mode 100644 index 000000000..4d82fa8ec --- /dev/null +++ b/docs/user-guide/index.md @@ -0,0 +1,24 @@ +--- +layout: user-guide +--- + +Slang User's 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. +- 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-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) +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. -- cgit v1.2.3