Add Readme and License

This commit is contained in:
2017-10-31 15:22:53 +00:00
parent 1fc74f78b2
commit d386d49ee8
2 changed files with 54 additions and 0 deletions

33
README.md Normal file
View File

@@ -0,0 +1,33 @@
# Dan Head's dotfiles
A collection of configuration files for frequently used applications, like
[terminal](https://github.com/thestinger/termite), [zsh](http://www.zsh.org/),
[Vim](http://www.vim.org/), [i3 (window manager)](https://i3wm.org/) and
[Irssi](https://irssi.org/) amongst others.
## Contents
Folder | Description
--- | ---
bin | Binary files and scripts
i3 | i3 config files
i3blocks | i3blocks config and associated scripts
irssi | Irssi config and theme
termite | Termite config file and terminfo file
vim | vimrc file and colours
zsh | zsh config file and aliases
## Installation
I would recommend against cloning and using this repository as it is heavily
customised for my use, instead I would fork it and customise to your liking, or
simply copy out the bits you want.
My setup consists of either updating applications to reference the config files
directly from the repository, or where that is not possible, I use a symlink to
the applications default config location.
For example, to configure ZSH:
```
git clone git@github.com:danhead/dotfiles.git ~/.dotfiles
ln -s ~/.dotfiles/zsh/.zshrc ~/
```