gst-uninstalled: make the bash prompt override optional

When using a custom prompt the automatic override may not look good, so
provide a mechanism to disable it.

Document that the user will have to use GST_ENV manually when setting
the prompt to have a visual indicator of the gst-uninstalled
environment.

1 files changed, 13 insertions, 1 deletions

diff --git a/README.md b/README.md
index 5ccc9ef18f..8e1ac7a1ca 100644
--- a/README.md
+++ b/README.md
@@ -136,7 +136,19 @@ built in a `build` directory you can simply run:
 
 ### Bash prompt
 
-We automatically handle `bash` and set `$PS1` accordingly
+We automatically handle `bash` and set `$PS1` accordingly.
+
+If the automatic `$PS1` override is not desired (maybe you have a fancy custom prompt), set the `$GST_BUILD_DISABLE_PS1_OVERRIDE` environment variable to `TRUE` and use `$GST_ENV` when setting the custom prompt, for example with a snippet like the following:
+
+```bash
+...
+if [[ -n "${GST_ENV-}" ]];
+then
+  PS1+="[ ${GST_ENV} ]"
+fi
+...
+
+```
 
 ### Zsh prompt