summaryrefslogtreecommitdiff
path: root/README
blob: 93cda74d3b48ada132fb030caa03f071d9201744 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
This is Sean Whitton's dotfiles.  I try to make it clear when stuff
was written by me, and when it was taken from elsewhere.  Stuff I've
written is GPL v3 or any later versions published by the FSF.

The master branch should work on most hosts, and host-specific
configurations for host `host.domain' live in the branch `host'.  All
such host branches have master as their parent and are rebased onto
master: the only exception is some branches based on `win32' for
specific Windows hosts.

This restriction is to make usage less complex, even if it results in
some patches being duplicated between multiple host branches (that
aren't suitable for master).  My dotfiles are too important for the
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