summaryrefslogtreecommitdiff
path: root/docs/user-guide/README.md
diff options
context:
space:
mode:
authorYong He <yonghe@outlook.com>2021-03-30 13:48:38 -0700
committerGitHub <noreply@github.com>2021-03-30 13:48:38 -0700
commita0ef865ebe37fc3a9c747f3e2a9c1cf8c38c4bad (patch)
tree47f02a9ee03501d219342965fdb21fad6b96ccee /docs/user-guide/README.md
parentc4d8551eba47ddc2621f29024d88d5b7ecef06f3 (diff)
Rename README.md to index.md
Diffstat (limited to 'docs/user-guide/README.md')
-rw-r--r--docs/user-guide/README.md24
1 files changed, 0 insertions, 24 deletions
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
deleted file mode 100644
index 4d82fa8ec..000000000
--- a/docs/user-guide/README.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-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.