diff options
| author | Tim Foley <tfoleyNV@users.noreply.github.com> | 2018-02-02 10:38:22 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-02-02 10:38:22 -0800 |
| commit | 58475a8aa42284722a3763aa3bde49f2fa40366e (patch) | |
| tree | 33149d981bf63dc7583fdadbcc7d54cd319a2057 /docs/building.md | |
| parent | 0360f81b9741ece65768a65731bd23455a3b7a96 (diff) | |
Revamp documentation (#395)
- Remove references to building by embedding source (not recommended at this point)
- Push users more toward binary builds rather than building from source (but include a document that talks about how to build)
- Remove most (all?) references to supporting GLSL input
- Expand the language guide to talk about the new features
- Add a document that talks about the parameter layout algorithm
Diffstat (limited to 'docs/building.md')
| -rw-r--r-- | docs/building.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/building.md b/docs/building.md new file mode 100644 index 000000000..68e57ec2d --- /dev/null +++ b/docs/building.md @@ -0,0 +1,18 @@ +# Building Slang From Source + +## Get the Source Code + +Clone [this](https://github.com/shader-slang/slang) repository, and then run: + + git submodule update --init + +The submodule update step is required to pull in the copy of the `glslang` compiler that we currently use for generating SPIR-V. + +## Using Visual Studio + +Building from source is really only well supported for Windows users with Visual Studio 2015 or later. +If you are on Windows, then open `slang.sln` and build your desired platform/configuration. + +## Linux + +For Linux, we include a simple `Makefile`, but it is not designed to be used for active development (e.g., dependency tracking is not handled). |
