From 98d793a04aa33173be026fed9b6eb57735f09a74 Mon Sep 17 00:00:00 2001 From: James Dixon Date: Fri, 9 Oct 2020 20:12:42 -0400 Subject: [PATCH] update readme and file structure --- README.md | 16 ++++++++++------ {bash => stow/bash}/.bash_profile | 0 {bash => stow/bash}/.bashrc | 0 {git => stow/git}/.gitconfig | 0 .../.local/scripts/completions/hugoctl_comp.bash | 0 {scripts => stow/scripts}/.local/scripts/hugoctl | 0 {tmux => stow/tmux}/.tmux.conf | 0 {vim => stow/vim}/.vim/.gitignore | 0 {vim => stow/vim}/.vim/vimrc | 0 {vim => stow/vim}/.vim/vimrc.min | 0 10 files changed, 10 insertions(+), 6 deletions(-) rename {bash => stow/bash}/.bash_profile (100%) rename {bash => stow/bash}/.bashrc (100%) rename {git => stow/git}/.gitconfig (100%) rename {scripts => stow/scripts}/.local/scripts/completions/hugoctl_comp.bash (100%) rename {scripts => stow/scripts}/.local/scripts/hugoctl (100%) rename {tmux => stow/tmux}/.tmux.conf (100%) rename {vim => stow/vim}/.vim/.gitignore (100%) rename {vim => stow/vim}/.vim/vimrc (100%) rename {vim => stow/vim}/.vim/vimrc.min (100%) diff --git a/README.md b/README.md index b753bd0..8977907 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -# My Dotfiles +# My dotfiles -Using [GNU Stow](https://www.gnu.org/software/stow/) to symlink files in this -repo to their correct locations under `$HOME` +I am using [GNU Stow](https://www.gnu.org/software/stow/) to symlink +my dotfiles to their correct locations in my `$HOME` directory. -Clone this repo in `~` and run the following: +## Instructions -```shell -cd ~/dotfiles && stow * +First `cd` into the `stow` directory and run the following command + +```sh +stow * -t "$HOME" ``` + +If there are no errors, everything in that directory should be symlinked. diff --git a/bash/.bash_profile b/stow/bash/.bash_profile similarity index 100% rename from bash/.bash_profile rename to stow/bash/.bash_profile diff --git a/bash/.bashrc b/stow/bash/.bashrc similarity index 100% rename from bash/.bashrc rename to stow/bash/.bashrc diff --git a/git/.gitconfig b/stow/git/.gitconfig similarity index 100% rename from git/.gitconfig rename to stow/git/.gitconfig diff --git a/scripts/.local/scripts/completions/hugoctl_comp.bash b/stow/scripts/.local/scripts/completions/hugoctl_comp.bash similarity index 100% rename from scripts/.local/scripts/completions/hugoctl_comp.bash rename to stow/scripts/.local/scripts/completions/hugoctl_comp.bash diff --git a/scripts/.local/scripts/hugoctl b/stow/scripts/.local/scripts/hugoctl similarity index 100% rename from scripts/.local/scripts/hugoctl rename to stow/scripts/.local/scripts/hugoctl diff --git a/tmux/.tmux.conf b/stow/tmux/.tmux.conf similarity index 100% rename from tmux/.tmux.conf rename to stow/tmux/.tmux.conf diff --git a/vim/.vim/.gitignore b/stow/vim/.vim/.gitignore similarity index 100% rename from vim/.vim/.gitignore rename to stow/vim/.vim/.gitignore diff --git a/vim/.vim/vimrc b/stow/vim/.vim/vimrc similarity index 100% rename from vim/.vim/vimrc rename to stow/vim/.vim/vimrc diff --git a/vim/.vim/vimrc.min b/stow/vim/.vim/vimrc.min similarity index 100% rename from vim/.vim/vimrc.min rename to stow/vim/.vim/vimrc.min