dotfiles/README.md

76 lines
2.4 KiB
Markdown
Raw 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.
More details about specific application configurations can be found in their
respective directories.
2017-08-16 02:35:10 +00:00
### Requirements
2015-04-28 19:45:13 +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.
Notable Plugins
* [Fugitive](https://github.com/tpope/vim-fugitive) for nice Git integration.
* [Polyglot](https://github.com/sheerun/vim-polyglot) for language files.
* [vimwiki](https://github.com/vimwiki/vimwiki) for info, diary and notes.
* [goyo](https://github.com/junegunn/goyo.vim) for zen-like text editing.
### Tmux
My tmux configuration is very straight forward and fully commented. Of note, I
enable mouse mode, and have custom colors configured.
#### Tmux Plugins
- [TPM](https://www.github.com/tmux-plugins/tpm): The TMUX Plugin Manager
- [Scroll-Wheel Copy Mode](https://www.github.com/nhdaly/tmux-scroll-copy-mode)
#### Custom Scripts
- clocks.sh: My custom status bar. Shows time for 4 different time zones.
### Git
### Bash
2015-03-09 17:28:20 +00:00
2017-08-16 02:35:10 +00:00
## To-Do
2015-04-23 01:52:00 +00:00
* [ ] irssi config files
* [ ] Bash config files
* [ ] 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.