From 157332c66795cd0c255e751eab5eeb3082f7955a Mon Sep 17 00:00:00 2001 From: Michael Tang Date: Sat, 12 Sep 2020 13:54:29 -0700 Subject: [PATCH] Add note about line endings --- shaders/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/shaders/README.md b/shaders/README.md index 31f847ae..7c23a1d2 100644 --- a/shaders/README.md +++ b/shaders/README.md @@ -24,3 +24,8 @@ shell. You'll need to set these environment variables for `make` to succeed: export GLSLANG=glslangValidator.exe export SPIRVCROSS=spirv-cross.exe ``` + +Note: the Windows versions of `glslangValidator` and `spirv-cross` may change +the line endings of the generated output. Please take care to ensure that +unintended line ending changes aren't accidentally commited, for instance by +[configuring Git to automatically handle line endings](https://docs.github.com/en/github/using-git/configuring-git-to-handle-line-endings#global-settings-for-line-endings).