aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2012-01-20 10:49:25 +1300
committerTom Ryder <tom@sanctum.geek.nz>2012-01-20 10:49:25 +1300
commit722483864149c1e3fa764059fa46717cf2ab057f (patch)
tree04a89ed459ad6ad1ec0bbb0afd0cce54f6f23a66 /README
parentUse recommended read-only paths for submodules. (diff)
downloaddotfiles-722483864149c1e3fa764059fa46717cf2ab057f.tar.gz
dotfiles-722483864149c1e3fa764059fa46717cf2ab057f.zip
Add more thorough instructions on repository use.
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 15 insertions, 5 deletions
diff --git a/README b/README
index 61e62074..0f3a38b7 100644
--- a/README
+++ b/README
@@ -1,9 +1,19 @@
-cd
+Personal repository of independent dotfiles.
+
+This is for all my personal configuration files that migrate well from machine
+to machine. Note the presence of submodules, which means after checking out I
+need to do something like:
+
+$ git submodule init
+$ git submodule update
+
+Then it's a matter of symlinking everything in:
+
rm -fr .vim
-rm -f .vimrc
-rm -f .gvimrc
-rm -f .gitconfig
-rm -f .screenrc
+rm -fr .vimrc
+rm -fr .gvimrc
+rm -fr .gitconfig
+rm -fr .screenrc
ln -s .dotfiles/vim .vim
ln -s .dotfiles/vim/vimrc .vimrc
ln -s .dotfiles/vim/gvimrc .gvimrc