Commit 971941d0 authored by Jake Howard's avatar Jake Howard
Browse files

Added installation instructions

parent deb85e92
......@@ -5,11 +5,16 @@ Command-Line tool for syncing dotfile-like files and configs between computers,
### Prerequisites
* Python 3
* Pip
* Linux / OSX Operating System
__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.
Alternatively, you can install it in 1 simple command. This allows you to install it in the best place for your OS, instead od wherever you run the `install.sh` script. The command below may need to be run as a superuser.
pip3 install git+https://github.com/RealOrangeOne/dotfile-automator.git
## 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.
......
#!/usr/bin/bash
set -e
if [ ! -f ./setup.py ]; then
echo ">> Cloning repo..."
git clone https://github.com/RealOrangeOne/dotfile-automator.git
cd yoga-pal
fi
echo ">> Building Virtualenv..."
pyvenv env
echo ">> Building Application..."
env/bin/python3 setup.py develop
echo ">> Installing Application..."
sudo pip install -e .
echo ">> Installation Complete!"
......@@ -4,7 +4,8 @@ setup (
name='dotfile-automator',
version='0.0',
install_requires=[
'click'
'click',
'PyYaml'
],
entry_points='''
[console_scripts]
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment