https://github.com/chuyeow/dotfiles

chuyeow.files
https://github.com/chuyeow/dotfiles

Last synced: about 1 month ago
JSON representation

chuyeow.files

• Host: GitHub
• URL: https://github.com/chuyeow/dotfiles
• Owner: chuyeow
• Created: 2013-10-06T03:21:47.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2021-02-07T03:46:06.000Z (about 4 years ago)
• Last Synced: 2024-11-07T20:16:15.836Z (3 months ago)
• Language: Shell
• Homepage:
• Size: 79.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Chu Yeow's dotfiles

My dotfiles, inspired by [holman/dotfiles](https://github.com/holman/dotfiles).

## Installation

```

git clone [email protected]:chuyeow/dotfiles.git ~/.dotfiles

cd ~/.dotfiles

script/bootstrap

```

The [script/bootstrap](script/bootstrap) script sets things up by symlinking

files in `.dotfiles` to your home directory. Everything lives within

`~/.dotfiles`.

## Topical

Everything's built around topic areas. If you're adding a new area, say, "Go",

you can simply add a `go` 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`.

## The breakdown

* `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/*.symlink`: Any files ending in `*.symlink` get symlinked into your `$HOME`.

## OS X defaults

Set up OS X the way I like it:

```

./osx/set-defaults.sh

```

## TODO

* Use different files depending on OS (e.g. `tmux.conf` for Mac OX S uses `reattach-to-user-name`).