Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 3.41 KB

README.md

File metadata and controls

94 lines (61 loc) · 3.41 KB
Raw

Hotell's dotfiles

Inspired by awesome Formation and Mathias dotfiles

Screenshot of my shell prompt

Installation

Warning: If you want to give these dotfiles a try, you should first fork this repository, review the code, and remove things you don’t want or need. Don’t blindly use my settings unless you know what that entails. Use at your own risk!

Using Git and the bootstrap script

You can clone the repository wherever you want.

(I like to keep it in ~/Projects/dotfiles, with ~/dotfiles as a symlink.)

The bootstrapper script will pull in the latest version and copy the files to your home folder.

mkdir ~/Projects && cd $_ && \
git clone https://github.com/hotell/dotfiles.git && \
ln -s ~/Projects/dotfiles ~/dotfiles && \
cd dotfiles && \
source bootstrap.sh

To update, cd into your local dotfiles repository and then:

source bootstrap.sh

Alternatively, to update while avoiding the confirmation prompt:

set -- -f; source bootstrap.sh

Git-free install

To install these dotfiles without Git:

cd; curl -#L https://github.com/hotell/dotfiles/tarball/master | tar -xzv --strip-components 1 --exclude={README.md,LICENSE-MIT.txt,swag,bootstrap.sh,execute-order-66.sh,npm.sh,brew.sh,utils.sh}

To update later on, just run that command again.

Specify the $PATH

If ~/.path exists, it will be sourced along with the other files, before any feature testing (such as detecting which version of ls is being used) takes place.

Here’s an example ~/.path file that adds /usr/local/bin to the $PATH:

export PATH="/usr/local/bin:$PATH"

Add custom commands without creating a new fork

If ~/.extra exists, it will be sourced along with the other files. You can use this to add a few custom commands without the need to fork this entire repository, or to add commands you don’t want to commit to a public repository.

My ~/.extra looks something like this:

# Git credentials
# Not in the repository, to prevent people from accidentally committing under my name
GIT_AUTHOR_NAME="Martin Hochel"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
git config --global user.name "$GIT_AUTHOR_NAME"
GIT_AUTHOR_EMAIL="[email protected]"
GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
git config --global user.email "$GIT_AUTHOR_EMAIL"

You could also use ~/.extra to override settings, functions and aliases from my dotfiles repository. It’s probably better to fork this repository instead, though.

Setup macOS defaults / Install Homebrew formulae / MacOS Apps from AppStore / global npm packages

When setting up a new Mac, you may want to install some common Homebrew formulae, your AppStore apps and npm global packages:

cd ~/dotfiles && ./execute-order-66.sh

NOTE:

Some of the functionality of these dotfiles depends on formulae installed by brew.sh. If you don’t plan to run brew.sh, you should look carefully through the script and manually install any particularly important ones. A good example is Bash/Git completion: the dotfiles use a special version from Homebrew.

Feedback

Suggestions/improvements welcome!