diff --git a/README.md b/README.md index 949a039..10844f0 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # brethil's dotfiles # -A set of zsh dotfiles +A set of zsh dotfiles based on antigen and oh-my-zsh ## Description ## -1. brethil_dotfile.sh: main file sourced by ~/.bash_profile +1. brethil_dotfile.sh: main file sourced by ~/.zshrc 2. aliases.sh: contains alias definitions (sources ~/.dotfiles_aliases) 3. functions.sh: contains function definitions (sources ~/.dotfiles_functions) 4. colors.sh: contains color definitions @@ -22,9 +22,12 @@ from the git repo every two weeks. This also updates the git-sourced repositorie by the install script. The self-update routine can be called manually by calling `dotfiles_selfupdate` (defined in `functions.sh`). +If you do not want to run the installer script, you can just add source `brethil_dotfile.sh` +in your .zshrc. This requires antigen installed. + ### Installed ### -0. oh-my-zsh (zsh config framework, lots of plugins available at https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins) +0. antigen (zsh plugin manager) + oh-my-zsh Two zsh themes: brethil and brethil-minimal. 1. amix's awesome vimrc (https://www.github.com/amix/vimrc). A quite nice vim rc. 2. byobu (wrapper/config for tmux, a screen multiplexer) @@ -37,6 +40,8 @@ by the install script. The self-update routine can be called manually by calling 5. rmate remote for Textmate (can be called with `mate`/`rmate`) 6. mtr (my traceroute, traceroute+ping network utility) 7. htop (better top) + + ### Available Functions ### 0. `cheat`, show cheat sheet for commands using cheat.sh (`cheat commandname`)