aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxero <x@xero.nu>2014-07-14 13:23:05 -0400
committerxero <x@xero.nu>2014-07-14 13:23:05 -0400
commit56560fd597f94dfe6fe5fa79648398ab29d05775 (patch)
tree7e77d23be98b2df8ef847f49ee645085356305be /README.md
parent1434c859bcf94a0bbee88e72c8a01849d0356293 (diff)
downloaddotfiles_ascii-56560fd597f94dfe6fe5fa79648398ab29d05775.tar.xz
dotfiles_ascii-56560fd597f94dfe6fe5fa79648398ab29d05775.zip
updated repo to manage dotfiles via gnu stow, the symlink farm manager. happy birthday commit! :birthday: :sparkles:
Diffstat (limited to 'README.md')
-rw-r--r--README.md82
1 files changed, 74 insertions, 8 deletions
diff --git a/README.md b/README.md
index d0c9b0f..a7cb505 100644
--- a/README.md
+++ b/README.md
@@ -17,17 +17,83 @@
░░░░░░░░░░
awesome > awesome wm config and ghost theme
- code/fun > term color, sys info, and other misc scripts
- code/sys > system automation scripts
+ compton > minimal composite config for opacity
+ fun > term color, sys info, and other misc scripts
+ sys > system automation scripts
fonts > config for gohu and bitmap fonts
git > global git config and aliases
+ herbstluftwm > herbstluft wm config and greybeard theme
mc > midnight commander ui colors
+ mpd > music player daemon setup
ncmpcpp > ncurses mpc++ ui/color settings
- sublime-text-2 > greybeard theme
- vimrc > vim custom airline bar and plugins
- Xdefaults > urxvt ui/color settings
- xinitrc > x bootstrap for awesome wm on crunchbang
- zshrc > z shell settings, aliases, prompts
+ ryu-login > ryu ansi art for /etc/issue tty login
+ sublime > sublime text 2 with greybeard, monokai, and gohu
+ vim > vim custom airline bar and plugins
+ urxvt > urxvt terminal colors and keyboard settings
+ zsh > zshell settings, aliases, and custom prompts
```
+#managing
+it's been said of every console user: _"you are your dotfiles"_.
-![](https://raw.github.com/xero/dotfiles/master/preview.png)
+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 gnu/linux and most other unix like distributions via your package manager.
+
+- `sudo pacman -S stow`
+- `sudo apt-get install stow`
+- `brew install stow`
+
+#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 **herbstluft** theme 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 the root zsh settings
+
+`sudo stow zsh-root -t /root`
+
+install awesomewm theme
+
+`stow awesome`
+
+uninstall awesome theme
+
+`stow -D awesome`
+
+install herbstluftwm
+
+`stow herbstluftwm` \ No newline at end of file