https://github.com/anthonycorletti/dotfiles
Connecting the dots.
https://github.com/anthonycorletti/dotfiles
brew dotfiles python ruby shell zsh
Last synced: 12 months ago
JSON representation
Connecting the dots.
- Host: GitHub
- URL: https://github.com/anthonycorletti/dotfiles
- Owner: anthonycorletti
- License: mit
- Created: 2020-05-11T23:49:05.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T20:02:47.000Z (over 1 year ago)
- Last Synced: 2024-11-14T21:18:07.621Z (over 1 year ago)
- Topics: brew, dotfiles, python, ruby, shell, zsh
- Language: Shell
- Homepage:
- Size: 259 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotfiles
Your dotfiles are how you personalize your system. These are mine.
## 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 `script/bootstrap`.
## what's inside
Lots of stuff. Check them out in the file browser above and see what components mesh with you.
[Fork it](https://github.com/anthonycorletti/dotfiles/fork), remove what you don't
use, and build on what you do use.
## 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/path.zsh**: Any file named `path.zsh` is loaded first and is
expected to setup `$PATH` or similar.
- **topic/completion.zsh**: Any file named `completion.zsh` is loaded
last and is expected to setup autocomplete.
- **topic/install.sh**: Any file named `install.sh` is executed when you run `script/install`.
To avoid being loaded automatically, its extension is `.sh`, not `.zsh`.
- **topic/\*.symlink**: Any file ending in `*.symlink` gets 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 `script/bootstrap`.
## install
Run this:
```sh
git clone https://github.com/anthonycorletti/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/bootstrap
```
This will symlink the appropriate files in `.dotfiles` to your home directory.
Everything is configured and tweaked within `~/.dotfiles`.
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.
`dotfiles` is a simple script that installs some dependencies, sets sane macOS
defaults, and so on. Tweak this script, and occasionally run `dotfiles` from
time to time to keep your environment fresh and up-to-date. You can find
this script in `bin/`.
## bugs
I want this to work for everyone; that means when you clone it down it should
work for you even though you may not have `rbenv` installed, for example. That
said, I do use this as _my_ dotfiles, so there's a good chance I may break
something if I forget to make a check for a dependency.
If you're brand-new to the project and run into any blockers, please
[open an issue](https://github.com/anthonycorletti/dotfiles/issues) on this repository
and I'd love to get it fixed for you!
## thanks
I forked [Zach Holman](http://github.com/holman)'s excellent
[dotfiles](http://github.com/holman/dotfiles) for a few years before I was
inspired to roll my own with plenty of inspiration and examples from Zach's.
If you're interested in the philosophy behind why projects like these are
awesome, you might want to [read his post on the
subject](http://zachholman.com/2010/08/dotfiles-are-meant-to-be-forked/).