NAME

PACKAGE ROOT

First, you'll need to create a root directory (from now on PKG_ROOT) on the
server which shall from now on host all your packages.
Then you need to put the caretaker git repository into PKG_ROOT/caretaker - it's recommended
to do this via git clone --bare.

Copy the pkglist script (examples/pkglist) to PKG_ROOT/pkglist.

Now you can add your own packages as git repos in PKG_ROOT.

To use caretaker with your packages on a machine, download and execute
the bootstrap script (examples/bootstrap).
On the package root, you can get it from the bare caretaker repository with
git cat-file blob master:examples/pkglist

THE LINKS FILE

Note that the '$etc' used in this example is a relative symlink.
So if you want to symlink something which is in a subdirectory of your home,
you will have to set the target to ../$etc/something (or similar).

Example:

soft .ssh/config ../$etc/config

ADDING A CLIENT

Now that you have a package root and some packages, you might start to wonder
how to actually start using them on some machine.

In theory, this is quite trivial. caretaker ships a bootstrap script in
examples/bootstrap (again, you can get it from the bare repo with
git cat-file blob master:examples/bootstrap). Execute the script to see
its help message, then execute it again with the proper arguments on the
machine on which you want to use caretaker and watch its output.

With the terminology from the previous sections, in most cases you'll need
./bootstrap ssh://server/$PKG_ROOT.
If you deploy caretaker on the server containing the package root,
./bootstrap /$PKG_ROOT will suffice.