diff --git a/gitstatus/README.md b/gitstatus/README.md index ad47e308..2196d30f 100644 --- a/gitstatus/README.md +++ b/gitstatus/README.md @@ -1,119 +1,2 @@ -# gitstatus -**gitstatus** enables much faster vcs/git prompt in -[Powerlevel10k](https://github.com/romkatv/powerlevel10k) ZSH theme. It works on Mac OS, Linux, FreeBSD and WSL. See [benchmarks](https://github.com/romkatv/powerlevel10k#how-fast-is-it). +This is a bundled copy of [gitstatus](https://github.com/romkatv/gitstatus) ZSH plugin. -## Installation - -1. Install [Powerlevel10k](https://github.com/romkatv/powerlevel10k) ZSH theme. - -2. If you use WSL (even occasionally), it's a good idea to define this option in your `.zshrc`: - -```zsh -# When running on WSL, do not scan dirty files in git repos with over 4k files. -[[ $( /lib/x86_64-linux-gnu/libc.so.6 (0x00007f59e6823000) - /lib64/ld-linux-x86-64.so.2 (0x00007f59e700b000) -``` - -On Mac OS: - -```zsh -$ otool -L gitstatusd -gitstatusd: - /usr/lib/libc++.1.dylib (compatibility version 1.0.0, current version 400.9.4) - /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1252.200.5) -``` - -To verify that it works type the following command from a clean zsh shell (run `zsh -df` to get there): - -```zsh -GITSTATUS_DAEMON=./gitstatusd source ./gitstatus.plugin.zsh && [[ -v GITSTATUS_DAEMON_PID ]] && echo works || echo broken -``` - -## More Docs - -Run `gitstatusd --help` for help or read the same thing in [options.cc](https://github.com/romkatv/gitstatus/blob/master/src/options.cc). - -There are also docs in [gitstatus.plugin.zsh](https://github.com/romkatv/gitstatus/blob/master/gitstatus.plugin.zsh). - -## License - -GNU General Public License v3.0. See [LICENSE](https://github.com/romkatv/gitstatus/blob/master/LICENSE).