Update READMEs.
diff --git a/README.md b/README.md
index f322636..ab68e49 100644
--- a/README.md
+++ b/README.md
@@ -7,12 +7,11 @@
A collection of tools, libraries and tests for shader compilation.
At the moment it includes:
-- [`glslc`](glslc), a command line compiler for GLSL to SPIR-V, and
-- `libshaderc` a library API for doing the same.
+- [`glslc`](glslc), a command line compiler for GLSL/HLSL to SPIR-V, and
+- [`libshaderc`](libshaderc), a library API for doing the same.
-Shaderc wraps around core functionality in
-[Glslang](https://github.com/KhronosGroup/glslang)
-and [SPIRV-Tools](https://github.com/KhronosGroup/SPIRV-Tools). Shaderc aims to
+Shaderc wraps around core functionality in [glslang][khr-glslang]
+and [SPIRV-Tools][spirv-tools]. Shaderc aims to
to provide:
* a command line compiler with GCC- and Clang-like usage, for better
integration with build systems
@@ -31,7 +30,7 @@
Those repos are downstream from GitHub.)
For licensing terms, please see the [`LICENSE`](LICENSE) file. If interested in
-contributing to this project, please see [`CONTRIBUTING.md`](CONTRIBUTING.md)
+contributing to this project, please see [`CONTRIBUTING.md`](CONTRIBUTING.md).
This is not an official Google product (experimental or otherwise), it is just
code that happens to be owned by Google. That may change if Shaderc gains
@@ -50,18 +49,17 @@
- `third_party/`: third party open source packages; see below
- `utils/`: utility scripts for Shaderc
-Shaderc depends on `glslang`, the Khronos reference compiler for GLSL.
+Shaderc depends on glslang, the Khronos reference compiler for GLSL.
Sometimes a change updates both Shaderc and glslang. In that case the
-glslang change will appear in [google/glslang](https://github.com/google/glslang)
-before it appears upstream in
-[KhronosGroup/glslang](https://github.com/KhronosGroup/glslang).
+glslang change will appear in [google/glslang][google-glslang]
+before it appears upstream in [KhronosGroup/glslang][khr-glslang]
We intend to upstream all changes to glslang. We maintain the separate
copy only to stage those changes for review, and to provide something for
Shaderc to build against in the meantime. Please see
[DEVELOPMENT.howto.md](DEVELOPMENT.howto.md) for more details.
-Shaderc depends on [SPIRV-Tools](https://github.com/KhronosGroup/SPIRV-Tools)
-for assembling and disassembling SPIR-V binaries.
+Shaderc depends on [SPIRV-Tools][spirv-tools] for assembling, disassembling,
+and transforming SPIR-V binaries.
Shaderc depends on the [Google Test](https://github.com/google/googletest)
testing framework.
@@ -212,3 +210,7 @@
Then the coverage report can be found under the `$BUILD_DIR/coverage-report`
directory.
+
+[khr-glslang]: https://github.com/KhronosGroup/glslang
+[google-glslang]: https://github.com/google/glslang
+[spirv-tools]: https://github.com/KhronosGroup/SPIRV-Tools
diff --git a/glslc/README.asciidoc b/glslc/README.asciidoc
index 5a546f2..a7cdad4 100644
--- a/glslc/README.asciidoc
+++ b/glslc/README.asciidoc
@@ -5,7 +5,8 @@
== Name
-`glslc` - A command-line GLSL to SPIR-V compiler with Clang-compatible arguments.
+`glslc` - A command-line GLSL/HLSL to SPIR-V compiler with
+Clang-compatible arguments.
== Synopsis
@@ -27,7 +28,7 @@
=== Input file languages
-glslc accepts both GLSL source and SPIR-V assembly files as inputs.
+glslc accepts both GLSL/HLSL source and SPIR-V assembly files as inputs.
==== Shader stage specification
diff --git a/libshaderc/README.md b/libshaderc/README.md
index d5e9ec3..bf9d317 100644
--- a/libshaderc/README.md
+++ b/libshaderc/README.md
@@ -5,10 +5,10 @@
## Build Artifacts
There are two main shaderc libraries that are created during a CMake
-compilation. The first is `libshaderc`, which is a static library
-containing just the functionality exposed by libshaderc. It depends
+compilation. The first is `libshaderc`, which is a static library
+containing just the functionality exposed by libshaderc. It depends
on other compilation targets `glslang`, `OSDependent`, `OGLCompiler`,
-`shaderc_util` and `SPIRV`.
+`shaderc_util`, `SPIRV`, `HLSL`, `SPIRV-Tools`, and `SPIRV-Tools-opt`.
The other is `libshaderc_combined`, which is a static library containing
libshaderc and all of its dependencies.
@@ -34,15 +34,18 @@
platforms `-lpthread` should also be specified.
4. If the external project does not use CMake and cannot use
-libshaderc_combined, the following libraries or their platform-dependent
+`libshaderc_combined`, the following libraries or their platform-dependent
counterparts should be linked in the order specified.
- `build/libshaderc/libshaderc.a`
- `build/third_party/glslang/glslang/glslang.a`
- `build/third_party/glslang/glslang/OSDependent/{Platform}/libOSDependent.a`
- `build/third_party/glslang/OGLCompilersDLL/libOGLCompiler.a`
- `build/third_party/glslang/libglslang.a`
- `build/shaderc_util/libshaderc_util.a`
- `build/third_party/glslang/SPIRV/libSPIRV.a`
+ * `build/libshaderc/libshaderc.a`
+ * `build/third_party/glslang/glslang/glslang.a`
+ * `build/third_party/glslang/glslang/OSDependent/{Platform}/libOSDependent.a`
+ * `build/third_party/glslang/OGLCompilersDLL/libOGLCompiler.a`
+ * `build/third_party/glslang/libglslang.a`
+ * `build/shaderc_util/libshaderc_util.a`
+ * `build/third_party/glslang/SPIRV/libSPIRV.a`
+ * `build/third_party/glslang/hlsl/libHLSL.a`
+ * `build/third_party/spirv-tools/libSPIRV-Tools-opt.a`
+ * `build/third_party/spirv-tools/libSPIRV-Tools.a`
5. If building for Android using the Android NDK, `shaderc/Android.mk` can be
included in the application's `Android.mk` and `LOCAL_STATIC_LIBRARIES:=shaderc`
