Update README

This commit is contained in:
Trysdyn Black 2020-05-01 19:30:45 -07:00
parent cd67a505db
commit ba294f112d

View file

@ -1 +1,16 @@
Personal dotfiles
#dotfiles
Personal dotfiles; probably not much here of value for anyone not me.
In essence this repo will mimic the layout of my homedir with a bunch of dotfiles and utility scripts in the right locations as if this were my homedirectory.
The setup_dotfiles.py script takes the contents of this path and creates symlinks in my actual homedir, matching the directory structure.
# Requirements
* Python 3.4
* A home directory
# Setup
* Clone the repo
* `python3 setup_dotfiles.py`
You can run the setup script from any path and it'll figure out what to do. The script will create symlinks in your home directory matching its layout. If you want to create the tree in a different location, you'll need to open the interpreter and manually invoke `install_dotfiles()` with the correct arguments.