Various changes
This commit is contained in:
19
README.md
19
README.md
@ -2,14 +2,25 @@
|
||||
This is my personal zsh configuraton.
|
||||
|
||||
### Requirements
|
||||
* [exa](https://github.com/ogham/exa) (optional) - better ls
|
||||
* [bat](https://github.com/sharkdp/bat) (optional) - better cat, less, man, etc.
|
||||
* [starship](https://github.com/starship/starship) - a pretty and fast prompt
|
||||
* [trash-cli](https://github.com/andreafrancia/trash-cli)* - safer rm
|
||||
* [direnv](https://github.com/direnv/direnv)* - runs on cd, safely set enviroment
|
||||
* [exa](https://github.com/ogham/exa)* - better ls
|
||||
* [bat](https://github.com/sharkdp/bat)* - better cat, less, man, etc.
|
||||
|
||||
(* = optional)
|
||||
|
||||
### Installation
|
||||
1. Clone this repo and init the submodules
|
||||
```sh
|
||||
git clone 'https://git.zander.im/Zander671/zsh-config.git'
|
||||
git submodule init && git submodule update
|
||||
```
|
||||
2. Create a `.zshrc` and fill it with something like this:
|
||||
> ZSH_CONFIG_DIR="path/to/this/repo"
|
||||
> source "${ZSH_CONFIG_DIR}/init.zsh}"
|
||||
```zsh
|
||||
ZSH_CONFIG_DIR="path/to/this/repo" # This variable *MUST* be set
|
||||
source "${ZSH_CONFIG_DIR}/init.zsh}"
|
||||
```
|
||||
3. Optionally, set some other variables (before the `source` line):
|
||||
* ZSH_BOOKMARK_DIR: Bookmark directory (default: ~/.cache/zsh/bookmarks)
|
||||
* ZSH_BOOKMARK_LS: If true, run `ls` after jumping to a bookmark
|
||||
|
Reference in New Issue
Block a user