summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAlan Pearce2017-04-25 16:07:58 +0200
committerAlan Pearce2017-04-25 16:07:58 +0200
commitf81a1a87a6e62912e55b7e1c369acc565afa93cd (patch)
tree5e996643ddc7053a08881a874737c72b3bb9d1e8
parent42e6eb4f62d10a09c24299a61cfe1f4ff354dd09 (diff)
downloadnixfiles-f81a1a87a6e62912e55b7e1c369acc565afa93cd.tar.lz
nixfiles-f81a1a87a6e62912e55b7e1c369acc565afa93cd.tar.zst
nixfiles-f81a1a87a6e62912e55b7e1c369acc565afa93cd.zip
Update readme
-rw-r--r--README.org24
1 files changed, 21 insertions, 3 deletions
diff --git a/README.org b/README.org
index 7333ed34..2ed06332 100644
--- a/README.org
+++ b/README.org
@@ -7,6 +7,11 @@ It doesn't use any configuration frameworks, just packages installed
 via package managers.  For Z shell I use [[https://zplug.sh/][zplug]] and for Emacs I use the
 built-in package.el via [[https://github.com/jwiegley/use-package][use-package]].
 
+I've included a wrapper script for =stow= which sets the target
+directory to =$HOME=, instead of =../=.  This allows the repository to
+be cloned anywhere, instead of following the =stow= convention of
+being one level below the target directory.
+
 It should work on:
 - Linux
 - OSX
@@ -15,17 +20,30 @@ It should work on:
 
 ** Installation
 
-Installing a set of dotfiles with stow is simple.  For example, with
+Clone the project anywhere, e.g. with =[[https://github.com/motemen/ghq][ghq]]=
+
+#+BEGIN_SRC sh :exports code
+ghq get git://git.alanpearce.eu/dotfiles
+ghq look git.alanpearce.eu/dotfiles
+#+END_SRC
+
+Or just with normal git
+
+#+BEGIN_SRC sh :exports code
+git clone git://git.alanpearce.eu/dotfiles ~/projects/alanpearce-dotfiles
+#+END_SRC
+
+Installing a set of dotfiles with =stow= is simple.  For example, with
 Emacs:
 
 #+BEGIN_SRC sh :exports code
-stow -S emacs
+./stow -S emacs
 #+END_SRC
 
 And then to uninstall
 
 #+BEGIN_SRC sh :exports code
-stow -D emacs
+./stow -D emacs
 #+END_SRC
 
 *** Z Shell