From 26fdd1ea67e8c03347b5ae183a5abd0ff1c5f787 Mon Sep 17 00:00:00 2001 From: Jidbo Date: Thu, 12 Dec 2019 00:16:26 +0100 Subject: [PATCH] update readme --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6f55090..edc059f 100644 --- a/README.md +++ b/README.md @@ -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/`.