https://github.com/andreapavoni/dotfiles
~/.dotfiles
https://github.com/andreapavoni/dotfiles
Last synced: about 1 year ago
JSON representation
~/.dotfiles
- Host: GitHub
- URL: https://github.com/andreapavoni/dotfiles
- Owner: andreapavoni
- Created: 2014-02-14T15:25:19.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T14:49:40.000Z (over 1 year ago)
- Last Synced: 2025-03-29T05:11:19.273Z (over 1 year ago)
- Language: Lua
- Homepage:
- Size: 13.8 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
# ~/.dotfiles
## Install
- `git clone git://github.com/andreapavoni/dotfiles ~/.dotfiles`
- `cd ~/.dotfiles`
- `brew bundle Brewfile`
- `rake install`
The install rake task will symlink the appropriate files in `.dotfiles` to your
home directory. Everything is configured and tweaked within `~/.dotfiles`,
though.
The main file you'll want to change right off the bat is `zsh/zshrc.symlink`,
which sets up a few paths that'll be different on your particular machine.
## Topical
Everything's built around topic areas. If you're adding a new area to your
forked dotfiles — say, "Java" — you can simply add a `java` directory and put
files in there. Anything with an extension of `.zsh` will get automatically
included into your shell. Anything with an extension of `.symlink` will get
symlinked without extension into `$HOME` when you run `rake install`.
## Components
There's a few special files in the hierarchy.
- **bin/**: Anything in `bin/` will get added to your `$PATH` and be made
available everywhere.
- **topic/\*.zsh**: Any files ending in `.zsh` get loaded into your
environment.
- **topic/\*.symlink**: Any files ending in `*.symlink` get symlinked into
your `$HOME`. This is so you can keep all of those versioned in your dotfiles
but still keep those autoloaded files in your home directory. These get
symlinked in when you run `rake install`.
- **topic/\*.completion.sh**: Any files ending in `completion.sh` get loaded
last so that they get loaded after we set up zsh autocomplete functions.
## Credits
I started by forking [Stefano Verna](http://github.com/stefanoverna)'s excellent
[dotfiles](http://github.com/stefanoverna/dotfiles).