dotfiles/README.md

66 lines
2 KiB
Markdown
Raw Permalink Normal View History

2017-08-16 02:35:10 +00:00
# Dot Files
2015-03-09 17:28:20 +00:00
2015-04-28 19:45:13 +00:00
Configuration files (often called dot-files because they start with a ".") for
the applications I use on a regular basis.
2017-08-16 02:35:10 +00:00
### Requirements
2015-04-28 19:45:13 +00:00
2017-11-13 21:37:26 +00:00
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.
2015-04-28 19:45:13 +00:00
2017-08-16 02:35:10 +00:00
## Installation
2015-04-28 19:45:13 +00:00
> 1. git clone git@github.com:VagabondAzulien/dotfiles.git
>
> 2. cd dotfiles
>
> 3. Type `make` to see your options
2015-04-28 19:45:13 +00:00
2017-08-16 02:35:10 +00:00
## Applications Configured
### Vim
My vim configuration is relatively straight forward and thoroughly commented.
#### Plugin File
The vimrc-plugins file stores the plugin information for
[Vim-Plug](https://github.com/junegunn/vim-plug). Included in the file is a
command to check for and pull-down the vim-plug files, if not previously
installed. All configurations related to plugins goes into this file also, so if
I want a plugin-free install, I can ignore this file and still run fine.
### Tmux
My tmux configuration is very straight forward and fully commented. Of note, I
2017-12-19 20:39:33 +00:00
enable mouse mode, have custom colors, and have a custom clock script for the
status bar (`clocks.sh`).
### Git
2017-11-13 21:37:26 +00:00
My git configuration is a skeleton `gitconfig` file, and an always-growing
2017-12-19 20:39:33 +00:00
`gitignore` file.
### Bash
2017-12-19 20:39:33 +00:00
My `bashrc` includes a custom prompt, several PATH additions, and
several custom functions.
2017-11-13 21:37:26 +00:00
The `bashrc-remote` file I use for any remote environments I'm in. The prompt is
different, and some of the functions aren't included.
2015-03-09 17:28:20 +00:00
2017-08-16 02:35:10 +00:00
## To-Do
* [ ] Improve makefile
2017-08-16 02:35:10 +00:00
## License
All files are licensed under the [WTFPL](http://www.wtfpl.net/), the full
2015-03-09 17:28:20 +00:00
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.