https://github.com/remy/dotfiles
My dotfiles (definitely a WIP)
https://github.com/remy/dotfiles
Last synced: about 2 months ago
JSON representation
My dotfiles (definitely a WIP)
- Host: GitHub
- URL: https://github.com/remy/dotfiles
- Owner: remy
- License: unlicense
- Created: 2016-03-30T08:52:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T10:10:12.000Z (almost 5 years ago)
- Last Synced: 2025-03-19T02:01:44.421Z (7 months ago)
- Language: Shell
- Size: 96.7 KB
- Stars: 35
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Remy's (mac) dotfiles
## ⚠ WARNING ⚠
These dotfiles still need work to complete an automatic installation. Use at your own risk (I do...).
I'm also using these on a Mac (and have tried with varying degrees of success on linux), so your milage may vary...
## 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 keep mine in `~/dotfiles`). The bootstrapper script will pull in the latest version and copy the files to your home folder.
```bash
git clone https://github.com/remy/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/remy/dotfiles/tarball/master | tar -xzv --strip-components 1 --exclude={README.md,bootstrap.sh,LICENSE}
```
To update later on, just run that command again.
### Specify the `$PATH`
Because the `:` split thing in `.path` files is a PITA, I've got a script that reads each line from `.paths`. The `.paths` file supports comments, so you can read mine and see how it's just a list of directories.
That list is then compiled and exported via `$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="Remy Sharp"
GIT_AUTHOR_EMAIL="remy@remysharp.com"
git config --global github.user "remy"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
git config --global user.name "$GIT_AUTHOR_NAME"
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](https://github.com/remy/dotfiles/fork) instead, though.
### Sensible OS X defaults
When setting up a new Mac, you may want to set some sensible OS X defaults:
```bash
./.osx
```
### Installing apps
When setting up a new Mac, you may want to install some common [Homebrew](http://brew.sh/) formulae (after installing Homebrew, of course):
```bash
./apps.sh
```
I've also included my default global npm packages, which is installed via
```bash
./npm.sh
```
## Feedback
Suggestions/improvements
[welcome](https://github.com/remy/dotfiles/issues)!
## Author
- [Remy Sharp](https://remysharp.com/)
Large amounts taken directly from [Mathias Bynens](https://mathiasbynens.be/)' [dotfiles repo](https://github.com/mathiasbynens/dotfiles) ❤
## Thanks to...
* @ptb and [his _OS X Lion Setup_ repository](https://github.com/ptb/Mac-OS-X-Lion-Setup)
* [Ben Alman](http://benalman.com/) and his [dotfiles repository](https://github.com/cowboy/dotfiles)
* [Chris Gerke](http://www.randomsquared.com/) and his [tutorial on creating an OS X SOE master image](http://chris-gerke.blogspot.com/2012/04/mac-osx-soe-master-image-day-7.html) + [_Insta_ repository](https://github.com/cgerke/Insta)
* [Cătălin Mariș](https://github.com/alrra) and his [dotfiles repository](https://github.com/alrra/dotfiles)
* [Gianni Chiappetta](http://gf3.ca/) for sharing his [amazing collection of dotfiles](https://github.com/gf3/dotfiles)
* [Jan Moesen](http://jan.moesen.nu/) and his [ancient `.bash_profile`](https://gist.github.com/1156154) + [shiny _tilde_ repository](https://github.com/janmoesen/tilde)
* [Lauri ‘Lri’ Ranta](http://lri.me/) for sharing [loads of hidden preferences](http://osxnotes.net/defaults.html)
* [Matijs Brinkhuis](http://hotfusion.nl/) and his [dotfiles repository](https://github.com/matijs/dotfiles)
* [Nicolas Gallagher](http://nicolasgallagher.com/) and his [dotfiles repository](https://github.com/necolas/dotfiles)
* [Sindre Sorhus](http://sindresorhus.com/)
* [Tom Ryder](http://blog.sanctum.geek.nz/) and his [dotfiles repository](https://github.com/tejr/dotfiles)
* [Kevin Suttle](http://kevinsuttle.com/) and his [dotfiles repository](https://github.com/kevinSuttle/dotfiles) and [OSXDefaults project](https://github.com/kevinSuttle/OSXDefaults), which aims to provide better documentation for [`~/.osx`](https://mths.be/osx)
* [Haralan Dobrev](http://hkdobrev.com/)
* anyone who [contributed a patch](https://github.com/mathiasbynens/dotfiles/contributors) or [made a helpful suggestion](https://github.com/mathiasbynens/dotfiles/issues)