update readme

This commit is contained in:
Jidbo 2019-12-12 00:16:26 +01:00
parent 004a01a005
commit 26fdd1ea67
No known key found for this signature in database
GPG key ID: 176CBC4DBB0A8965

View file

@ -1,16 +1,12 @@
# My Dotfiles
The collection of my dotfiles
The collection of my precious dotfiles.
## Dependencies
Everything should work without any of these depencies but it's not as fun.
- zsh
- vim
- git
- oh-my-zsh
- fzf
- silver_searcher
- powerline-fonts
- tmuxinator
## Installation
To install run this command:
```
git clone https://github.com/jidbo/.dotfiles ~/; cd ~/.dotfiles; ./install
```
This should install all dependecies and create symlinks to all needed files. The only thing that you have to setup on your own is `nvim`.
## Usage
If you have extra setup tasks, you can put them in `.localcommands`.
## Customization
It is possible to load your own zsh-plugins and other commands you want to execute in the `.zshrc`. To add zsh-plugins add a `plugins` file to `~/.dotfiles/shell/`. An example is provided in `~/.dotfiles/shell/plugins.example`. The same thing applies to commands you want to execute in on shell startup, just add a `localcommands` file with your commands in `~/.dotfiles/shell/`.