diff options
| author |  Mike Burns <mike@mike-burns.com> | 2013-06-07 16:58:59 +0200 |
|---|---|---|
| committer | Mike Burns <mike@mike-burns.com> | 2013-06-07 16:58:59 +0200 |
| commit | 98378cdc179316482f472890f3e5c0f49b29f249 (patch) | |
| tree | 30c24458fd775a05e26c524489574fe5d440eef4 | |
| parent | 0f1fbc3c0458355917a79cb4e76925573562bda1 (diff) | |
Add a README
Introduce a README to describe the project, installation, support, and
license.
| -rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..40acc40 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +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` and `mkrc`. + +Installation +------------ + +You can install into `/usr/local` using a normal `make install`: + + sudo make install + +The `PREFIX` can be changed as needed: + + make install PREFIX=$HOME/.local + +Programs +-------- + +* `rcup` is the main program. It is used to install and update dotfiles, + with support for tags and host-specific files. +* `mkrc` is for introducing a dotfile into your dotfiles directory, with + support for tags. + +Support +------- + +Pull requests welcome. + +License +------- + +Copyright 2013 Mike Burns. BSD license. |