/dotfiles

My personal dotfiles for macOS and Linux 👨‍💻

Primary LanguageShellMIT LicenseMIT

Angelo's dotfiles

Dotfiles preview

🤗  These dotfiles help me to set up and maintain my macOS or Linux installations. They intend to automate the installation and update process of, well, everything. Feel free to explore, copy and re-use the code to your liking.

Installation

💥  Warning: Please fork and review the code first, before giving these dotfiles a try. In theory, they can be installed on an existing system as well, but a fresh installation is recommended. Use at your own risk.

macOS notes: Make sure to install the Xcode Command Line Tools by running xcode-select --install first, then log into iCloud and the Apple App Store.

The following command will install the dotfiles into ~/.dotfiles and runs the installer automatically 🤖:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/finalangel/dotfiles/master/bootstrap)"

🤔  Yeah that's it, really, I think...

The dot command

👉  Once installed, use the following command to manage the dotfiles:

$ dotfiles --help
Usage: dotfiles [options]

Options:
  -e, --edit     Edit dotfiles
  -g, --go       Go to dotfiles directory
  -h, --help     Show help
  -i, --install  Runs installer
  -u, --update   Runs updater

What's included

Except for utils/ and scripts/ every folder is its self-containing topic/ providing an install and update script. You can easily disable individual topics/ by commenting the lines in scripts/. On top of that:

  • every aliases.zsh, paths.zsh and functions.zsh file in topics/ is automatically loaded
  • every .symlink file in topics/ will be mapped to ~/.[filename]
  • everything in the bin/ folder gets automatically added to your $PATH

The following package flavours are installed:

Contributions

🐛  Feel free to send me pull requests if something is misconfigured or could be enhanced upon. These are very personal, but if they work for others as well, the more, the merrier. I generally still want to improve on:

  • Adding tests would be nice :)

Credits

❤️  Many thanks to the dotfiles community and the excellent work from dotphiles, holman, mathiasbynens, pchampio and webpro. This work wouldn't be possible without them.