summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2015-05-26 18:09:26 +0900
committerSean Whitton <spwhitton@spwhitton.name>2015-05-26 18:09:26 +0900
commit8f896f18ce62ffac94bb5d2e900c641b9c134712 (patch)
tree2ccf5b3628b2910d0ccae32bb01c5715fa9b505d /README
parent8812027bbece01b0d8fca52ed326ba2a10a6b7d0 (diff)
downloaddotfiles-8f896f18ce62ffac94bb5d2e900c641b9c134712.tar.gz
basic usage instructions in README
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
index 6306abda..1524db15 100644
--- a/README
+++ b/README
@@ -15,3 +15,22 @@ repository to require time-consuming, complex rebase operations. In
particular, the restriction allows for the `mr update' and `mr rebase'
commands to be simple scripts that almost always do exactly what's
needed.
+
+===========================
+Minimal system requirements
+===========================
+
+git, the usual POSIX userland
+
+================================
+Recommended pre-installed extras
+================================
+
+GNU stow, myrepos
+
+=============
+Minimal setup
+=============
+
+1. Get the repo: git clone https://github.com/spwhitton/dotfiles.git src/dotfiles
+2. Run botstrap script: src/dotfiles/bin/bstraph.sh