diff --git a/README.md b/README.md index 2ca104f..5d24c94 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ -# dotfiles +# Fabio's dotfiles -## Update settings +## Installation -`cd ~/dotfiles` +Run the following command from the **HOME** directory: -`source bootstrap.sh` +`git clone https://github.com/hspazio/dotfiles.git` + +`cd ~/dotfiles` + +Run installation tasks + +* `rake install:brew` uses [Homebrew Bundle] (https://github.com/Homebrew/homebrew-bundle) to install all the packages specified in the `Brewfile` +* `rake install:zsh` installs and configures `zsh` +* `rake install:vim` installs [Vundle](https://github.com/VundleVim/Vundle.vim) as package manager and other dependencies +* `rake install:ctags` sets up Vim and Ruby environment to work with ctags +* After that we need to link the dotfiles to the **HOME** directory. For this we will use: +`rake link`. This will command will also source `.zshrc` in order to apply the changes to the shell and will also install any new Vim packages. + +* For a detailed list of tasks run `rake -T`