https://github.com/rjames86/dotfiles

https://github.com/rjames86/dotfiles

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/rjames86/dotfiles
• Owner: rjames86
• Created: 2016-03-28T01:43:03.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-21T03:54:08.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T14:12:54.521Z (3 months ago)
• Language: Shell
• Size: 8.05 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred-test - rjames86/dotfiles - (Shell)

README

        
## Installation

Based on https://github.com/mathiasbynens/dotfiles

**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.

```bash

git clone https://github.com/mathiasbynens/dotfiles.git && cd dotfiles && source bootstrap.sh

```

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

```bash

source bootstrap.sh

```

Alternatively, to update while avoiding the confirmation prompt:

```bash

set -- -f; source bootstrap.sh

```

### Git-free install

To install these dotfiles without Git:

```bash

cd; curl -#L https://github.com/mathiasbynens/dotfiles/tarball/master | tar -xzv --strip-components 1 --exclude={README.md,bootstrap.sh,LICENSE-MIT.txt}

```

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](https://github.com/mathiasbynens/dotfiles/blob/aff769fd75225d8f2e481185a71d5e05b76002dc/.aliases#L21-26)) takes place.

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

```bash

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:

```bash

# Git credentials

# Not in the repository, to prevent people from accidentally committing under my name

GIT_AUTHOR_NAME="Mathias Bynens"

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"

```

### Sensible OS X defaults

When setting up a new Mac, you may want to set some sensible OS X defaults:

```bash

./.osx

```

### Install Homebrew formulae

When setting up a new Mac, you may want to install some common [Homebrew](http://brew.sh/) formulae (after installing Homebrew, of course):

```bash

./brew.sh

```