diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ce34273 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Dan Head + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..78de6fc --- /dev/null +++ b/README.md @@ -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 ~/ +```