https://github.com/mateusjunges/dotfiles

My personal dotfiles - making anywhere feel like home
https://github.com/mateusjunges/dotfiles

bash dotfiles personal-dotfiles shell zsh

Last synced: 26 days ago
JSON representation

My personal dotfiles - making anywhere feel like home

• Host: GitHub
• URL: https://github.com/mateusjunges/dotfiles
• Owner: mateusjunges
• License: mit
• Created: 2019-07-11T06:25:37.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T03:00:18.000Z (3 months ago)
• Last Synced: 2024-08-05T04:24:03.331Z (3 months ago)
• Topics: bash, dotfiles, personal-dotfiles, shell, zsh
• Language: Shell
• Homepage:
• Size: 820 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# My personal dotfiles

![Readme banner](/art/readme-screenshot.png)

Your dotfiles are how you personalize your system. These are mine.

It contains the installation of some basic tools, some handy aliases and functions.

## Topical

Everything's built around topic areas. If you're adding a new are to your forked dotfiles, you can simply create a new 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`.

## 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 o 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 when you run `script/bootstrap`.

  

## Installation

You can install this dotfiles by cloning this repo as `.dotfiles` in your home directory and running the bootstrap script.

```bash

git clone [email protected]:mateusjunges/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 will be different on your particular machine.

`dot` is a simple script that installs dependencies and set MacOS defaults. Run `dot` from time to time to keep you environment fresh and up-to-date. The script can be found in `bin\`.