https://github.com/jogendra/dotfiles

Config files for zsh, bash, vim, git, completions etc. to set up a system the way I like it. ~/.jogendra
https://github.com/jogendra/dotfiles

applescript bash bashrc dotfiles dotfiles-macos git hacktoberfest iterm2 macos shell symlink vim xcode zsh zshrc

Last synced: 30 days ago
JSON representation

Config files for zsh, bash, vim, git, completions etc. to set up a system the way I like it. ~/.jogendra

• Host: GitHub
• URL: https://github.com/jogendra/dotfiles
• Owner: jogendra
• License: mit
• Created: 2020-04-03T15:49:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-06T08:24:33.000Z (over 1 year ago)
• Last Synced: 2024-10-29T23:35:25.138Z (about 1 month ago)
• Topics: applescript, bash, bashrc, dotfiles, dotfiles-macos, git, hacktoberfest, iterm2, macos, shell, symlink, vim, xcode, zsh, zshrc
• Language: Shell
• Homepage: https://jogendra.github.io/i-do-dotfiles
• Size: 79.1 KB
• Stars: 75
• Watchers: 2
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - jogendra/dotfiles - Config files for zsh, bash, vim, git, completions etc. to set up a system the way I like it. ~/.jogendra (Shell)

README

        
# I do dotfiles!

Config files for zsh, bash, git, completions etc. to set up a system the way I like it. ~/.jogendra

[https://jogendra.github.io/i-do-dotfiles](https://jogendra.github.io/i-do-dotfiles)



**NOTE**: The dotfiles is configured for MacOS machine. Most of the things expected to work on all machines running unix based operating systems.



## Components

I went through many dotfiles before deciding structure of this dotfiles, I found [holman](https://twitter.com/holman) way the best, Thanks to [holman dotfiles](https://github.com/holman/dotfiles). What he used is called _Topical organization_ which is organizing the different parts of dotfiles in directories, each entitled to a specific subject. By topical organization, all AppleScripts go inside the `AppleScript/` directory, git settings are in a `git/` directory, and so on. Everything's built around topic areas. If you're adding a new area to your forked dotfiles — say, "vscode" — you can simply add a vscode directory and put files in there.

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 `installers/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 `installers/bootstrap`.

## Install

Run:

```sh

git clone https://github.com/jogendra/dotfiles.git ~/.dotfiles

cd ~/.dotfiles

installers/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.

## Pimp my Terminnal

I will soon be writing detailed blog post on how my iTerm is customized.





## License

This repository is under MIT License. Check [LICENSE](LICENSE) file for more information.