Giter Club home page Giter Club logo

dotfiles's Introduction

Jamy's dotfiles repo

A dotfiles repo which includes install scripts for setting up the environment from a fresh operating system install. This dotfiles repo can be used for Linux and MacOS machines; I actively use this repo on my MacbookPro and Linux desktop machine, which I use interchangeably.

Currently only Debian Linux is supported.

What's included?

Shell

Z shell (Zsh) is installed on Linux and assumed to be there on MacOS.

Cli tools

Languages and package managers

Gui applications

Config

XDG Base Directory Specification is followed where possible.

  • jamygolden-dotfiles/.config/* is symlinked to $XDG_CONFIG_HOME/*.
  • .zshenv is symlinked to $HOME/.zshenv. It is the first zsh file to be sourced in the home directory, so it's required to be loaded there and set the ZSHDOTDIR environment variable for the other zsh scripts.
  • Put your .zprofile secrets in jamygolden-dotfiles/secrets/.z_secrets and .zshrc secrets in jamygolden-dotfiles/secrets/.zsh_secrets

Linux specific

  • jamygolden-dotfiles/.config/zsh/.zprofile is symlinked to $HOME/.profile because Intellij Idea doesn't use ZSH (even when specified) and it's important for the secrets to be sourced for Intellij Idea.

Dotfiles are installed to $XDG_CONFIG_HOME where possible.

Installation

If bash is installed by default, these scripts will run correctly and will set up Zsh as the default shell.

The installation will detect what OS you are using and will setup accordingly.

$ ./install_all.sh # Setups up Linux machine
$ ./install_symlinks.sh # Symlink dotfiles
$ ./install_post.sh # Postinstall

Zsh script Naming conventions

.zsh_* implies the file will only be run when .zshrc is run, while .z_* implies the file will be run in .z_profile. Read more about the Zsh startup/shutdown files.

Tests

After everything is installed, run ./z_tests in your shell to test your zsh setup to ensure it's running correctly.

dotfiles's People

Contributors

jamygolden avatar

Stargazers

 avatar  avatar

Watchers

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