mirror of https://github.com/akelge/zsh
Updated README
This commit is contained in:
parent
1d175dd9cc
commit
ff87851e7e
27
README.md
27
README.md
|
@ -1,4 +1,29 @@
|
||||||
# zsh
|
# zsh
|
||||||
My zsh configuration files
|
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 <url> /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.
|
||||||
|
|
|
@ -10,7 +10,7 @@ whence thefuck > /dev/null && eval $(thefuck --alias)
|
||||||
|
|
||||||
# z
|
# z
|
||||||
# [ -f $LIBRARY/plugins/zsh-z/zsh-z.plugin.zsh ] && source $LIBRARY/plugins/zsh-z/zsh-z.plugin.zsh
|
# [ -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)
|
eval $(zoxide init zsh)
|
||||||
export Z_COMMAND=zoxide
|
export Z_COMMAND=zoxide
|
||||||
elif [ -f $LIBRARY/plugins/zsh-z/zsh-z.plugin.zsh ]; then ## zsh-z is installed
|
elif [ -f $LIBRARY/plugins/zsh-z/zsh-z.plugin.zsh ]; then ## zsh-z is installed
|
||||||
|
|
Loading…
Reference in New Issue