summaryrefslogtreecommitdiff
path: root/README.md
blob: 843882f674d73aca0d9d21602b3397451b99c8e1 (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
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`, and `lsrc`.

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

Arch Linux:

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

Debian-based (including Ubuntu):

    wget http://mike-burns.com/project/rcm/rcm_1.0.0_all.deb
    sudo dpkg -i rcm_1.0.0_all.deb

OS X:

    brew tap mike-burns/rcm
    brew install rcm

Elsewhere:

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

    ./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.
* `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 `DEVELOPERS.MD`.

License
-------

Copyright 2013 Mike Burns. BSD license.