axos / dotfiles

axos' dotfiles

Prerequisites

• Unix-like operating system (macOS or Linux)
• curl and/or wget should be installed
• git should be installed
• Z shell: Install zsh
• Antigen: Run curl -L git.io/antigen > .antigen.zsh in your home folder. Be sure to install it to .antigen.zsh (with a .)

Recommendations

• fasd

Getting started

Clone this repo with git clone https://github.com/axos/dotfiles.git .dotfiles or git clone [e-mail]:axos/dotfiles.git .dotfiles. You can also clone this to git clone's default dotfiles folder (without the .), but it is recommended to clone it into .dotfiles in your home directory.

Symlinking files

Symlink all needed files to your home directory. With this approach all symlinked files in your home directory are actually aliases to the original files in your .dotfiles directory. Whenever you change them, the original files are automatically updated in the repository.

Example

ln -sv ~/.dotfiles/.zshrc ~

Symlinking with bootstrap script

You can also run the bootstrap script in order to symlink all dotfiles to your home directory. It excludes any files that have .exclude in their filename. Run sh bootstrap.exclude.sh while in your .dotfiles directory.

Config files

There are config files for

• Prettier (.prettierrc)
• sass-lint (.sass-lint.yml)
• stylelint (.stylelintrc.json)

They are mostly be used as global configuration files or can be copied to project folder. If copied to project, feel free to adjust them according to your project requirements.

Acknowledgements

• @ajmalsiddiqui and his article How to make your Dotfile management a painless affair
• @robbyrussell for the awesome oh-my-zsh