From 70eaad8d014f49c82f58fdd0006966a3ac1c1fd3 Mon Sep 17 00:00:00 2001 From: Quentin Duchemin Date: Thu, 3 May 2018 20:25:03 +0200 Subject: [PATCH] Add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..858a239 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# dotfiles + +### Contents + +Simple setup for i3, terminator, zsh with oh-my-zsh and a fancy [polybar](https://github.com/jaagr/polybar), screenshot to come. + +### Requirements + +* [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) +* [fasd](https://github.com/clvv/fasd) +* [Pygments](http://pygments.org/) (with `pygmentize` command) +* [Powerline Fonts](https://github.com/powerline/fonts) + +### Usage + +* Clone in bare repository : `git clone --bare https://github.com/Chostakovitch/dotfiles.git $HOME/.cfg`. A bare repository does not have a working tree (basically it is just `.git` content). So we avoid conflicts with another git repository. +* Create a working tree outside `.cfg` : `/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME checkout`. +* Adjust `DEFAUT_USER` in `~/.zshrc`. +* Source `~/.zshrc` and use provided `config` alias to pull. +* `config config --local status.showUntrackedFiles no` to ignore untracked files in status (better as it is home dir). + +Credits to [this great article](https://developer.atlassian.com/blog/2016/02/best-way-to-store-dotfiles-git-bare-repo/) for the trick.