From ff87851e7e572238f19a78139287ca4dd586747f Mon Sep 17 00:00:00 2001 From: Andrea Mistrali Date: Tue, 10 Oct 2023 13:06:53 +0200 Subject: [PATCH] Updated README --- README.md | 27 ++++++++++++++++++++++++++- zsh.d/90-plugins.zsh | 2 +- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7c602b4..5dc88b2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ # zsh My zsh configuration files -Good for Linux and OSX, tested on Ubuntu, CentOS, Debian and FreeBSD +Works on Linux, *BSD and OSX, tested on Ubuntu, CentOS, Debian, FreeBSD and several versions of macOS. + + +### Supported plugins + +There is native support for: + - [homebrew](https://brew.sh/); + - [zoxide](https://github.com/ajeetdsouza/zoxide), if not installed falls back to zsh-z native plugin; + - kubectl; + - [krew](ihttps://krew.sigs.k8s.io/); + - [pyenv](https://github.com/pyenv/pyenv); + - [thefuck](https://github.com/nvbn/thefuck) + + These plugins must be installed in another way, I only support using them + + There is also native support for [iTerm2](https://iterm2.com/) shell integration, if you are running on macOS + +### Installation + +- Clone recurively this repo in `/etc/zsh`: `sudo git clone --recurse /etc/zsh`; +- Copy `/etc/zsh/zshrc` in `/etc`; +- Done + +**NOTE**: on macOS with each update of the OS, the file `/etc/zshrc` is restored to the default, you will have to copy again the one in `/etc/zsh`: `sudo cp /etc/zsh/zshrc /etc/zshrc` + +If you prefer to avoid touching `/etc/` you can clone the repo in `~/.zsh` and copy the `zshrc` into `~/.zshrc`: `cp ~/.zsh/zshrc ~/.zshrc`, but then you have to add your own customisations to `.zshrc` at the end of the file. diff --git a/zsh.d/90-plugins.zsh b/zsh.d/90-plugins.zsh index 7892d8e..8c65dc0 100644 --- a/zsh.d/90-plugins.zsh +++ b/zsh.d/90-plugins.zsh @@ -10,7 +10,7 @@ whence thefuck > /dev/null && eval $(thefuck --alias) # z # [ -f $LIBRARY/plugins/zsh-z/zsh-z.plugin.zsh ] && source $LIBRARY/plugins/zsh-z/zsh-z.plugin.zsh -if [ $(whence zoxide > /dev/null) ]; then ## zoxide is installed +if whence zoxide > /dev/null; then ## zoxide is installed eval $(zoxide init zsh) export Z_COMMAND=zoxide elif [ -f $LIBRARY/plugins/zsh-z/zsh-z.plugin.zsh ]; then ## zsh-z is installed