From: Richard Hartmann <richih.mailinglist@gmail.com>
Date: Thu, 27 Oct 2011 14:56:51 +0000 (+0200)
Subject: Improve docs
X-Git-Url: https://git.madduck.net/code/vcsh.git/commitdiff_plain/f570c8e7078bda6a4d6ec037e9592edccdde0475?ds=sidebyside

Improve docs
---

diff --git a/INSTALL b/INSTALL
index 76d887b..5ac7510 100644
--- a/INSTALL
+++ b/INSTALL
@@ -81,26 +81,20 @@ Then look around in the clone. Should be reasonable simple to understand. If not
 
 # Clone vcsh and make it available
     git clone git://github.com/RichiH/vcsh.git vcsh
-    PATH+=":$HOME/work/git/vcsh"
-    export PATH
+    sudo ln -s ~/work/git/vcsh/vcsh /usr/bin/local
+    hash -r
 
 # Grab my mr config. see below for details on how I set this up
-    ~/work/git/vcsh/vcsh clone ssh://<remote>/mr.git
+    vcsh clone ssh://<remote>/mr.git
     cd ~/.config/mr/config.d/
     ln -s ../available.d/* .
 
-# make vcsh work by default. Adapt for Bash etc as needed
-    cd
-    zsh ~/work/git/vcsh/vcsh clone ssh://<remote>/zsh.git
-    ln -s ~/work/git/vcsh/vcsh .zsh/functions
-    zsh
-
 
 
 
 ################
 
-# mr
+# mr is used to actually retrieve configs, etc
 
     ~ % cat ~/.mrconfig
     [DEFAULT]
diff --git a/README b/README
index 5933b5a..d52283d 100644
--- a/README
+++ b/README
@@ -3,10 +3,10 @@ vcsh - manage and sync config files via git
 vcsh allows you to have several git repositories, all maintaining their working trees in $HOME without clobbering each other.
 That, in turn, means you can have one repository per config set (zsh, vim, ssh, etc), picking and choosing which configs you want to use on which machine.
 
-It's been written for use with zsh, but it works with bash and even sh. Expect full support for /bin/sh soonish.
+vcsh was designed with mr [1] in mind so you might want to install that, as well.
 
 
-vcsh was designed with mr [1] in mind so you might want to install that, as well.
+Read INSTALL for detailed setup instructions.
 
 
 Questions? RichiH@{freenode,OFTC,IRCnet}