aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2013-09-17 20:41:41 +1200
committerTom Ryder <tom@sanctum.geek.nz>2013-09-17 20:41:41 +1200
commitcc74d91ef652162e63a9d3d40bb3d1f315597702 (patch)
treed9591384c5df9dd996e90d31e0b95524469bfbbc /README.markdown
parentReplace text showing prompt with screenshot (diff)
downloaddotfiles-cc74d91ef652162e63a9d3d40bb3d1f315597702.tar.gz
dotfiles-cc74d91ef652162e63a9d3d40bb3d1f315597702.zip
Explain `install` script options
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index a24728c4..eccf31f1 100644
--- a/README.markdown
+++ b/README.markdown
@@ -18,8 +18,22 @@ There’s an installation script, but it’s pretty bare-bones, so don’t run i
without reading it first. You’ll need to have a recent enough version of Git to
support [submodules][1] for this to work.
+To install the core terminal-only files (ack, Bash, cURL, Git, Vim), use the
+following:
+
$ ~/.dotfiles/install
+You can add any combination of the following options to add configuration for
+other tools:
+
+* `-d` — `mysql` and `psql`
+* `-g` — GnuPG
+* `-m` — Mutt
+* `-n` — Ncmpcpp
+* `-r` — Newsbeuter
+* `-t` — tmux
+* `-x` — X11
+
The script will prompt you about replacing old files. If you’re brave/insane,
you can pipe `yes(1)` into it to accept all the replacements: