aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEhsan <ehsannas@gmail.com>2019-09-24 10:54:00 -0400
committerGitHub <noreply@github.com>2019-09-24 10:54:00 -0400
commit1cdfc756fc58d813222cb716c6cb795c1e3e868c (patch)
tree88a5e8c7bc3ce3ebf5514838760d99a346af6071
parent836e001d7be0092d71bf5e04989e7eaaa066c5c1 (diff)
parent7b1b05e78122b448c0d4c4e49b630b5e63e73b8c (diff)
downloadplatform_external_shaderc_spirv-headers-1cdfc756fc58d813222cb716c6cb795c1e3e868c.tar.gz
platform_external_shaderc_spirv-headers-1cdfc756fc58d813222cb716c6cb795c1e3e868c.tar.bz2
platform_external_shaderc_spirv-headers-1cdfc756fc58d813222cb716c6cb795c1e3e868c.zip
Merge pull request #129 from ehsannas/update_doc
Improve the doc on using Bazel.
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 27b393a..53c476f 100644
--- a/README.md
+++ b/README.md
@@ -73,7 +73,11 @@ See also the [example](example/) subdirectory. But since that example is
### Using Bazel
A Bazel-based project can use the headers without installing, as follows:
-1. Add a `local_repository` to your `WORKSPACE` file. For example:
+1. Add SPIRV-Headers as a submodule of your project, and add a
+`local_repository` to your `WORKSPACE` file. For example, if you place
+SPIRV-Headers under `external/spirv-headers`, then add the following to your
+`WORKSPACE` file:
+
```
local_repository(
name = "spirv_headers",
@@ -81,8 +85,8 @@ local_repository(
)
```
-2. Add one of the following to the `deps` of your build target based on your
-needs:
+2. Add one of the following to the `deps` attribute of your build target based
+on your needs:
```
@spirv_headers//:spirv_c_headers
@spirv_headers//:spirv_cpp_headers