Skip to content

Files

Latest commit

 

History

History
55 lines (43 loc) · 2.24 KB

README.md

File metadata and controls

55 lines (43 loc) · 2.24 KB

My dotfiles

Install

Warning: Before you proceed with the installation, please review the code beforehand. Optionally, fork this repository and remove things you don't want. Don’t blindly use my settings unless you know what that entails. Use at your own risk!

After you have reviewed the code, clone the repo, then run the install script:

chmod +x install.py
./install.py -h

The -h flag will display the help message, and you can proceed to run the script again with the options you want. An example might be like this:

./install.py -v -common -linux

The mapping file

The mapping.json file contains the symbolic link paths from this directory to the file system. The top level key names are the categories of the settings. They will be read by the install script and show up as options for the install. For example common will be used by the -common flag.

The keys under the categories are the paths to the config file/directory source relative to the dotfiles directory, the values are the absolute paths on the file system to symbolic link the config files to.

Optionally, you may provide a key called name to specify the name that will be printed on the screen by the help message for each category.

Credits and software used