summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCarlo Sala <carlosalag@protonmail.com>2024-10-08 20:26:23 +0200
committerCarlo Sala <carlosalag@protonmail.com>2024-10-08 20:41:58 +0200
commit2a109d30afe4ab164a946c307abc3d2a444a42ad (patch)
tree74a02a443c1e3e2fe0e8037467f21883543926b8 /README.md
parent0a6f88ba0672f38d6925f8ffc8e7658e99f37489 (diff)
downloadzsh-2a109d30afe4ab164a946c307abc3d2a444a42ad.tar.gz
zsh-2a109d30afe4ab164a946c307abc3d2a444a42ad.tar.bz2
zsh-2a109d30afe4ab164a946c307abc3d2a444a42ad.zip
feat(git): add escape hatch to enable async prompt
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 78db3a88f..1303292d2 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,7 @@ Twitter), and join us on [Discord](https://discord.gg/ohmyzsh).
- [Custom Plugins And Themes](#custom-plugins-and-themes)
- [Enable GNU ls In macOS And freeBSD Systems](#enable-gnu-ls-in-macos-and-freebsd-systems)
- [Skip Aliases](#skip-aliases)
- - [Disable async git prompt](#disable-async-git-prompt)
+ - [Async git prompt](#async-git-prompt)
- [Getting Updates](#getting-updates)
- [Updates Verbosity](#updates-verbosity)
- [Manual Updates](#manual-updates)
@@ -415,7 +415,7 @@ zstyle ':omz:lib:directories' aliases no
> It is also not currently aware of "aliases" that are defined as functions. Example of such are `gccd`,
> `ggf`, or `ggl` functions from the git plugin.
-### Disable async git prompt
+### Async git prompt
Async prompt functions are an experimental feature (included on April 3, 2024) that allows Oh My Zsh to render
prompt information asynchronously. This can improve prompt rendering performance, but it might not work well
@@ -426,6 +426,14 @@ turn it off by setting the following in your .zshrc file, before Oh My Zsh is so
zstyle ':omz:alpha:lib:git' async-prompt no
```
+If your problem is that the git prompt just stopped appearing, you can try to force it setting the following
+configuration before `oh-my-zsh.sh` is sourced. If it still does not work, please open an issue with your
+case.
+
+```sh
+zstyle ':omz:alpha:lib:git' async-prompt force
+```
+
## Getting Updates
By default, you will be prompted to check for updates every 2 weeks. You can choose other update modes by