summaryrefslogtreecommitdiff
path: root/README.md
blob: 139c0d7ebb523f4cc850f5f9464b777b17bb1e09 (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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
rcm
===

This is a management suite for dotfiles.

It assumes that you have a separate dotfiles directory, or are
interested in creating one.

The programs provided are `rcup`, `mkrc`, `rcdn`, and `lsrc`.

Installation
------------

Arch Linux:

  https://aur.archlinux.org/packages/rcm-git/

Debian-based (including Ubuntu):

    wget https://thoughtbot.github.io/rcm/debs/rcm_1.2.3-1_all.deb
    sudo dpkg -i rcm_1.2.3-1_all.deb

openSUSE/RHEL/CentOS: [instructions](http://software.opensuse.org/download.html?project=utilities&package=rcm)

Gentoo-based (including Funtoo):

    sudo emerge layman
    sudo layman -f --overlays https://github.com/bronislav/overlays/raw/master/layman.xml --add bronislav
    sudo emerge rcm

OS X:

    brew tap thoughtbot/formulae
    brew install rcm

Elsewhere:

This uses the standard GNU autotools, so it's the normal dance:

    wget https://thoughtbot.github.io/rcm/dist/rcm-1.2.3.tar.gz && \
    tar -xvf rcm-1.2.3.tar.gz && \
    cd rcm-1.2.3 && \

    ./configure && \
    make && \
    make install

For more, see `INSTALL`.

Programs
--------

* `rcup` is the main program. It is used to install and update dotfiles,
  with support for tags, host-specific files, and multiple source
  directories.
* `rcdn` is the opposite of `rcup`.
* `mkrc` is for introducing a dotfile into your dotfiles directory, with
  support for tags and multiple source directories.
* `lsrc` shows you all your dotfiles and where they would be symlinked
  to. It is used by `rcup` but is provided for your own use, too.

Support
-------

Pull requests welcome; see `CONTRIBUTING.md`.

License
-------

Copyright 2013 Mike Burns. BSD license.
Copyright 2014 thoughtbot. BSD license.