1
Fork 0
This repository has been archived on 2023-03-26. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Jake Howard cf2ff57970 Fixed config getting and setting 2015-12-06 14:20:55 +00:00
project Fixed config getting and setting 2015-12-06 14:20:55 +00:00
scripts Fixed config getting and setting 2015-12-06 14:20:55 +00:00
.gitignore Added download dir to ignore 2015-11-30 18:09:20 +00:00
LICENSE Initial commit 2015-11-27 19:46:59 +00:00
README.md Added testing badge 2015-12-05 23:31:49 +00:00
circle.yml Split local and CI testing 2015-12-03 22:46:26 +00:00
requirements.txt Fixed pyyaml version 2015-12-02 19:34:00 +00:00
setup.py Spelling! 2015-12-03 18:04:38 +00:00

README.md

DotFile Automator Circle CI

Command-Line tool for syncing dotfile-like files and configs between computers, using the power of Git.

Installation

Prerequisites

  • Python 3
  • Pip

Note: If you would like the tool to run faster, install libyml through your preffered package manager. This will allow reading from the config file faster.

The Installation Process

Installation can be done using the install.sh script in the root of the repo. Simply run it, with or without the repo pre-cloned. This will run through the installation automatically.

Configuration

Configuration is done using a simple config file in your home directory (~/.dfa.yml). This file is used to override the default values for your repo, in case it differs from what is used by default. If this file is not present, the tool can still be used fully.

Getting Started

After installation, you can test the tool is installed correctly by running:

dfa --help

If help text is displayed, you're good to go! If not, try repeating the installation steps again, or posting an issue on the issues page.