summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAlan Pearce2017-03-20 12:38:16 +0100
committerAlan Pearce2017-03-20 12:38:16 +0100
commitf8ec71a117760f22e2573f1a6d072547d6410f21 (patch)
treee3fc19c5f5fcb3a2e04277acb818c16be90d2446
parentd8364fdf028b6578ee3136d8cc17a36a4c0fbf3d (diff)
downloaddotfiles-f8ec71a117760f22e2573f1a6d072547d6410f21.tar.lz
dotfiles-f8ec71a117760f22e2573f1a6d072547d6410f21.tar.zst
dotfiles-f8ec71a117760f22e2573f1a6d072547d6410f21.zip
Add installation section to readme
-rw-r--r--README.org15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.org b/README.org
index e1fb43b..b22c80b 100644
--- a/README.org
+++ b/README.org
@@ -12,3 +12,18 @@ It should work on:
 - OSX
 - FreeBSD
 - Windows/Ubuntu
+
+** Installation
+
+Installing a set of dotfiles with stow is simple.  For example, with
+Emacs:
+
+#+BEGIN_SRC sh :exports code
+stow -S emacs
+#+END_SRC
+
+And then to uninstall
+
+#+BEGIN_SRC sh :exports code
+stow -D emacs
+#+END_SRC