From 493a2b92437e0fdddbe881e1c038aa6aba4941a2 Mon Sep 17 00:00:00 2001 From: Michael Tang Date: Sat, 12 Sep 2020 13:59:16 -0700 Subject: [PATCH] Add note on when this document is relevant --- shaders/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/shaders/README.md b/shaders/README.md index 7c23a1d2..d8c3b0e2 100644 --- a/shaders/README.md +++ b/shaders/README.md @@ -1,5 +1,9 @@ # Building the shaders +This document describes how to regenerate the shaders used by Pathfinder. Unless +you have modified files in this directory, regenerating the shaders is not +necessary to do most development on or use Pathfinder. + You will need `glslangValidator` and `spirv-cross` installed to execute the Makefile from this directory. You can speed up the build by parallelizing the build: `make -j`.