Update news for header location change and recommendation.
authorJohn Kessenich <cepheus@frii.com>
Tue, 2 Jun 2020 05:24:37 +0000 (23:24 -0600)
committerJohn Kessenich <cepheus@frii.com>
Tue, 2 Jun 2020 05:24:37 +0000 (23:24 -0600)
README.md

index e96ba99bc8743a63ff31b9973592b883f88cce37..a35dbb8c92319535c3c9fa4435e9ed6184c0ffa7 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,16 @@
 # News
 
+If you get a new **compilation error due to a missing header**, it might be caused by this planned removal:
+
+**SPIRV Folder, 1-May, 2020.** Glslang, when installed through CMake,
+will install a `SPIRV` folder into `${CMAKE_INSTALL_INCLUDEDIR}`.
+This `SPIRV` folder is being moved to `glslang/SPIRV`.
+During the transition the `SPIRV` folder will be installed into both locations.
+The old install of `SPIRV/` will be removed as a CMake install target no sooner than May 1, 2020.
+See issue #1964.
+
+If people are only using this location to get spirv.hpp, I recommend they get that from [SPIRV-Headers](https://github.com/KhronosGroup/SPIRV-Headers) instead.
+
 [![Build Status](https://travis-ci.org/KhronosGroup/glslang.svg?branch=master)](https://travis-ci.org/KhronosGroup/glslang)
 [![Build status](https://ci.appveyor.com/api/projects/status/q6fi9cb0qnhkla68/branch/master?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/glslang/branch/master)