README.rst

homefiles

Your files, anywhere.

What is homefiles?

homefiles is a program that helps you keep your files synced across
machines. Unlike Dropbox which syncs to-and-from a single location (the
Dropbox folder), homefiles allows you track files anywhere in your
home directory and sync them back to their original location, even when
syncing across machines.

This makes homefiles perfect for tracking your dot-files, like your
.bashrc and .vimrc. You're not limited to that, however. With
homefiles, you can track any type of file--a text file of
important phone numbers, perhaps-- or even entire directories,
for, say, keeping notes folder on all you machines in sync.

Also unlike Dropbox, homefiles stores your files in a git
repository, giving you the ability to track and rollback to earlier versions
of files if necessary.

homefiles is not a replacement for Dropbox or Google Drive--you
wouldn't want to store movies or photos in it. But for configuration and text
files, homefiles is a simple way to manage, version-control, and
distribute these across all your machines.

Bundles

The data repo is composed of directories called 'bundles'. Each bundle
represents a set of files to be copied onto the target machine.

Bundles come in two flavors, OS-specific and custom. OS-specific bundles will
only be synced to machines that have a matching OS, for example Mac's will
sync OS-Darwin bundles whereas Ubuntu will sync Linux, Ubuntu, and
potentially Ubuntu-13.04 bundles.

All machines will receive the Default bundle.

In addition, custom bundles can be defined which will be synced only when
directed to.

Bundle Layout

Within the bundle, the layout is relative to your home directory, so
Default/bin/foo.sh will be symlinked as $HOME/bin/foo.sh.

Likewise, OS-Darwin/Documents/code/mac_only.sh will symlink to
$HOME/Documents/code/mac_only.sh but only on Macs.

If a whole directory is being tracked, the .trackeddir marker file will be
present in it. This will cause the directory to be symlinked as a single unit,
rather than symlinking the individual files.