commit 3c2add49bfe096d9de7980e58c9c22a603326728
parent b1e4bf52a31b9cac7b6d80f485b4432d458f86e0
Author: Dane Fisher <hide4@comcast.net>
Date: Thu, 17 May 2018 00:53:50 -0400
Update README.md
Diffstat:
| M | README.md | | | 157 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- |
1 file changed, 155 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,2 +1,155 @@
-# .nix-
-nix files from my arch linux setup
+```
+ ██ ██ ████ ██ ██
+ ░██ ░██ ░██░ ░░ ░██
+ ░██ ██████ ██████ ██████ ██ ░██ █████ ██████
+ ██████ ██░░░░██░░░██░ ░░░██░ ░██ ░██ ██░░░██ ██░░░░
+ ██░░░██░██ ░██ ░██ ░██ ░██ ░██░███████░░█████
+░██ ░██░██ ░██ ░██ ░██ ░██ ░██░██░░░░ ░░░░░██
+░░██████░░██████ ░░██ ░██ ░██ ███░░██████ ██████
+ ░░░░░░ ░░░░░░ ░░ ░░ ░░ ░░░ ░░░░░░ ░░░░░░
+
+ ▓▓▓▓▓▓▓▓▓▓
+ ░▓ about ▓ Linux config files
+ ░▓ author ▓ underd0g <underd0g>
+ ░▓ code ▓ https://github.com/underd0g1/
+ ░▓ mirror ▓ students.ship.edu/df5076/about.html
+ ░▓▓▓▓▓▓▓▓▓▓
+ ░░░░░░░░░░
+
+ 2bwm > fast floating wm
+ bin > system automation scripts
+ compton > minimal composite config for opacity
+ figlet > custom 3d font
+ fonts > configs for gohu and other bitmap fonts
+ fun > term color, sys info, and other misc scripts
+ git > global git config and aliases
+ interrobang > a lightweight application launcher
+ irssi > neon gold irc theme
+ mpd > music player daemon setup
+ mutt > minimal mutt setup
+ ncmpcpp > ncurses mpc++ ui/color settings
+ pacman > pacman colors and progress bar animations
+
+ pygments > add syntax highlighting to cat and less commands
+ ranger > file manager with image previews and z3bra theme
+ ryu-login > ryu ansi art for /etc/issue tty login
+ ssh > remote ssh server keep alive
+ stalonetray > stand alone tray for daemons
+ themes > mod of the cathexis dark theme for gtk/qt/xfce
+ tmux > terminal multiplexer with custom status bar
+ urxvt > sourcerer terminal colors and keyboard settings
+ vim > wizard status bar and sourcerer color scheme
+ wallpaper > the cool desktop background images i use
+ zsh > zshell settings, aliases, and custom prompts
+```
+
+## table of contents
+ - [introduction](#dotfiles)
+ - [managing](#managing)
+ - [installing](#installing)
+ - [how it works](#how-it-works)
+ - [tl;dr](#tldr)
+ - [my shell](#my-shell)
+ - [vim](#vim)
+ - [previews](#previews)
+
+# dotfiles
+in the unix world programs are commonly configured in two different ways, via shell arguments or text based configuration files. programs with many options like window managers or text editors are configured on a per-user basis with files in your home directory `~`. in unix like operating systems any file or directory name that starts with a period or full stop character is considered hidden, and in a default view will not be displayed. thus the name dotfiles.
+
+it's been said of every console user:
+> _"you are your dotfiles"_.
+
+since they dictate how your system will look and function. to many users (see [ricers](http://unixporn.net) and [beaners](http://nixers.net)) these files are very important, and need to be backed up and shared. people who create custom themes have the added challenge of managing multiple versions of them. i have tried many organization techniques. and just take my word for it when i say, keeping a git repo in the root of your home directory is a bad idea. i've written custom shell scripts for moving or symlinking files into place. there are even a few dotfile managers, but they all seem to have lots of dependencies. i knew there had to be a simple tool to help me.
+
+# managing
+i manage mine with [gnu stow](http://www.gnu.org/software/stow/), a free, portable, lightweight symlink farm manager. this allows me to keep a versioned directory of all my config files that are virtually linked into place via a single command. this makes sharing these files among many users (root) and computers super simple. and does not clutter your home directory with version control files.
+
+# installing
+stow is available for all linux and most other unix like distributions via your package manager.
+
+- `sudo pacman -S stow`
+- `sudo apt-get install stow`
+- `brew install stow`
+
+or clone it [from source](https://savannah.gnu.org/git/?group=stow) and [build it](http://git.savannah.gnu.org/cgit/stow.git/tree/INSTALL) yourself.
+
+# how it works
+by default the stow command will create symlinks for files in the parent directory of where you execute the command. so my dotfiles setup assumes this repo is located in the root of your home directory `~/dotfiles`. and all stow commands should be executed in that directory. otherwise you'll need to use the `-d` flag with the repo directory location.
+
+to install most of my configs you execute the stow command with the folder name as the only argument.
+
+to install my **herbstluft** theme _greybeard_ use the command:
+
+`stow herbstluftwm`
+
+this will symlink files to `~/.config/herbstluftwm` and various other places.
+
+but you can override the default behavior and symlink files to another location with the `-t` (target) argument flag.
+
+to install the **ryu-login** you need to execute the command:
+
+`stow -t / ryu-login`
+
+this will symlink the file to `/etc/issue`.
+
+**note:** stow can only create a symlink if a config file does not already exist. if a default file was created upon program installation you must delete it first before you can install a new one with stow. this does not apply to directories, only files.
+
+# tl;dr
+navigate to your home directory
+
+`cd ~`
+
+clone the repo:
+
+`git clone http://git.xero.nu/dotfiles.git`
+
+enter the dotfiles directory
+
+`cd dotfiles`
+
+install the zsh settings
+
+`stow zsh`
+
+install zsh settings for the root user
+
+`sudo stow zsh -t /root`
+
+install awesomewm theme
+
+`stow awesome`
+
+uninstall awesome theme
+
+`stow -D awesome`
+
+install herbstluftwm
+
+`stow herbstluftwm`
+
+etc, etc, etc...
+
+#my shell
+i prefer a minimal setup, and choose to interact with my operating system via the so-called "terminal" or "command line", (read that quoting sarcastically) over a gui interface 2 times out of 3. with the web browser and video player among the noted outliers. in my opinion, using your computer should be a very personal experience. your colors, aliases, key-bindings, etc meticulously crafted to your exacting specifications. so for me, the unix shell is the most important part of my environment.
+
+
+
+my terminal emulator of choice is the lightweight, unicode, 256 color [urxvt](http://linux.die.net/man/1/urxvt). i use [zsh](http://linux.die.net/man/1/zsh) as my interactive shell. it's an extensible, bash like shell with awesome completion and correction engines. i manage multiple shell sessions with [tmux](http://linux.die.net/man/1/tmux). it's a feature packed terminal multiplexer with support for buffers, split windows, detached local and remote sessions, etc. i'm a member of the cult of [vim](http://linux.die.net/man/1/vim). sing phrases to the third reincarnation of the glorious ed! lel. [mpd](http://linux.die.net/man/1/mpd) is my music server and i use [ncmpcpp](http://ncmpcpp.rybczak.net/) as it's frontend. my configs for [urxvt](http://git.io/.urxvt), [zsh](http://git.io/.zsh), [tmux](http://git.io/.tmux), [vim](http://git.io/.vim), [mpd](http://git.io/.mpd) and [ncmpcpp](http://git.io/.ncmpcpp) shown above feature my [sourcerer](http://sourcerer.xero.nu) color scheme.
+
+# vim
+with it's tight integration to the unix shell, [vim](http://www.vim.org) has quickly become my editor of choice. once you start to master the movements and operators you quickly begin manipulating, not just editing source code files.
+
+when you learn vim it's best to use a more vanilla config. if helps you focus on learning the editor and not the plugins. vim's vast and powerful plugin system can add many great features. i try to keep my editor slim and fast, but i find myself loving these plugins:
+
+- [vundle](https://github.com/gmarik/vundle.vim) - to manage other plugins
+- [vim completes me](https://github.com/ajh17/VimCompletesMe) - super lightweight completion system
+- [colorizer](https://github.com/lilydjwg/colorizer) - display color codes as their colors inline
+- [syntastic](https://github.com/scrooloose/syntastic) - syntax linting
+- [git gutter](https://github.com/airblade/vim-gitgutter) - git diff in the gutter
+- [match it](https://github.com/isa/vim-matchit) - extended word and regex matching
+- [lightline](https://github.com/itchyny/lightline.vim) - custom status line (for much rice)
+- [fugitive](https://github.com/tpope/vim-fugitive) - fast git integration
+
+# Web
+
+ >> Read about me at students.ship.edu/df5076/about.html
