Git Product home page Git Product logo

dot's Introduction

.dot

This repository groups my different 'dot files' with a structure inspired from Zack Holman (https://github.com/holman/dotfiles). Following is an explanation of how my dotfiles work.

Concept

Everything's built around relationships. If you're adding a new relation to your dotfiles, say "pyhton", you can simply add a java directory in the rel folder 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 the setup script

Main Structure

  • bin/: Anything in bin/ will get added to your $PATH and be made available everywhere.
  • rel/: All relationships go in there.
  • run/: All scripts go in there.

Special files in <relation>

  • <relation>/*.zsh: Any .zsh file get loaded into your environment.
  • <relation>/path.zsh is loaded first and is expected to setup $PATH or similar.
  • <relation>/completion.zsh is loaded last and to setup autocomplete.
  • <relation>/install.sh is executed when you run run/install. To avoid being loaded automatically, its extension is .sh, not .zsh.
  • <relation>/*.symlink: Any file ending in *.symlink gets symlinked into your $HOME.

Scripts

  • setup : symlink everything
  • install : installs everything

Get Started

# Install homebrew
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

# Install the dotfiles
git clone https://github.com/fredmontet/dot.git ~/.dot
cd ~/.dot
make setup

This will symlink the appropriate files in .dot to your home directory. 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.

Usefull Commands

  • dot is a simple script that installs some dependencies, sets sane macOS defaults, and so on. Tweak this script, and occasionally run dot from time to time to keep your environment fresh and up-to-date. You can find this script in bin/.
  • reload does what it says. It reloads your dotfiles.

dot's People

Contributors

holman avatar memborsky avatar fredmontet avatar kirelagin avatar jacobwgillespie avatar gambtho avatar johnrees avatar pcasaretto avatar victorklos avatar metheon avatar christianbundy avatar ncolton avatar rcarver avatar prathe avatar zpao avatar anaisbetts avatar grawity avatar jawshooah avatar ghuntley avatar dplarson avatar calvn avatar sumeetjain avatar stephenyeargin avatar sibartlett avatar shanev avatar ch1bo avatar rtomayko avatar rmcastil avatar pravj avatar pmcdaniel avatar

Watchers

James Cloos avatar  avatar  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.