dotfiles/README.md
2017-08-15 22:35:10 -04:00

48 lines
1.4 KiB
Markdown

# Dot Files
Configuration files (often called dot-files because they start with a ".") for
the applications I use on a regular basis.
More details about specific application configurations can be found in their
respective directories.
### Requirements
You'll need `make` for the automated linking of the dotfiles.
Obviously you'll need the related program for each config file to be applicable.
## Installation
> 1. git clone git@github.com:VagabondAzulien/dotfiles.git
>
> 2. cd dotfiles
>
> 3. Type `make` to see your options
## Applications Configured
* Vim \[ vim/vim/ => ~/.vim \]\[ vim/vimrc => ~/.vimrc \]\[ vim/vimrc.bundles =>
~/.vimrc.bundles \]
* Git \[ git/gitconfig => ~/.gitconfig \]\[ git/gitignore => ~/.gitignore \]
* Tmux \[ tmux/tmux.conf => ~/.tmux.conf \]
## To-Do
* [ ] irssi config files
* [ ] Bash config files
* [ ] Improve makefile
## License
All files are licensed under the [WTFPL](http://www.wtfpl.net/), the full
license text of which can be found below.
> **DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE**
>
> _Version 2, December 2004_ ||
> _Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>_
>
> Everyone is permitted to copy and distribute verbatim or modified
> copies of this license document, and changing it is allowed as long
> as the name is changed.
>
> DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
> TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
>
> 0. You just DO WHAT THE FUCK YOU WANT TO.