GithubHelp home page GithubHelp logo

dotfiles's Introduction

theTizzo's dotfiles

My main goal with this project is to be able to easily move between machines without having to worry the differences in configuration between these machines. To that end, these dotfiles should be easy to install and update. It's should also be easy to figure out how to update the configuration of a specific tool on one system and update it everywhere.

Installation

git clone https://github.com/thetizzo/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/bootstrap

Structure

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.

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/install.os: Any file named install.os is executed when you run script/bootstrap. This is expected to install OS level dependencies which might be required by the install.sh scripts and is run before script/install.
  • 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.
  • topic/*.dsymlink: Any directory with a file named .dsymlink will to get symlinked into your $HOME. This is create for common config directories in the such as ~/.config.

Thanks

For many years, I maintained a disorgnanized heap of dotfiles that required manual installation and symlinking any time I set up a new machine. Then one day I ran across Zach Holman's dotfiles and really liked the layout of the project so I have based the structure and installation scripts of this project on Zach's.

dotfiles's People

Contributors

thetizzo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.