https://github.com/wei/dotfiles

@wei does dotfiles
https://github.com/wei/dotfiles

Last synced: 19 days ago
JSON representation

@wei does dotfiles

• Host: GitHub
• URL: https://github.com/wei/dotfiles
• Owner: wei
• Created: 2020-09-01T04:33:35.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-01T15:10:45.000Z (about 4 years ago)
• Last Synced: 2024-10-05T06:41:22.609Z (about 1 month ago)
• Language: Shell
• Homepage:
• Size: 9.77 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [@wei](https://github.com/wei) does dotfiles

## 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 `setup.sh`.

## 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/wei/dotfiles.git ~/dotfiles

cd $_

setup.sh

```

This will symlink the appropriate files in `dotfiles` to your home directory.

Everything is configured and tweaked within `~/dotfiles`.

## License

- [MIT](https://wei.mit-license.org/) - [@wei](https://github.com/wei)

- [MIT](https://github.com/holman/dotfiles/blob/master/LICENSE.md) - [@holman](https://github.com/holman)