Skip to content

jasonwc/bedrock

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bedrock

A framework for constructing a standardized setup for dotfiles.

Defaults:

EDITOR='vim'
PROJECT_BASE_DIR="$HOME/Development"

Setup

Installation

Run this:

git clone git@github.com:bedrock-env/bedrock.git

From the bedrock directory, run:

./script/bootstrap

bootstrap prompts for some configuration details such as your git author name and git author email. It then symlinks config files, runs script/install to install additional requirements, then installs any present extensions.

Post-install

  • Reload your terminal window or switch directories

If you wish to override things like PROJECT_BASE_DIR, do so in ~/.localrc.

Fonts

The recommended font to use in iTerm2 and Terminal is InputSans-Regular from the Input font collection.

iTerm2 (preferred)

For versions of iTerm2 earlier than Build 3.1.5:
  • Open iTerm2 -> Preferences -> General.
  • Check "Load Preferences from a custom folder or URL"
  • Set custom path to $BEDROCK_DIR/config
  • Relaunch iTerm2
  • Go to iTerm2 -> Preferences -> Profiles. Select the bedrock profile. Select the "Colors" tab.
  • Select "Load Presets" -> "Import..."
  • Select iterm2/bedrock.itermcolors
  • Relaunch iTerm2
  • Note: you may have to restart your machine for the shell settings to take effect
  • Uncheck "Load Preferences from a custom folder or URL"
For iTerm2 Build 3.1.5 and later:
  • Open iTerm2 -> Preferences -> General.
  • Check "Load Preferences from a custom folder or URL"
  • Set custom path to $BEDROCK_DIR/config.
  • iTerm will pop up a dialog box asking Copy local preferences to custom folder now?. Answer Don't Copy.
  • Close the Preferences dialog and relaunch iTerm2.
  • Go to iTerm2 -> Preferences -> Profiles. Select the bedrock profile.
    • If the "bedrock" profile is not available, it's probably because you previously chose Copy instead of Don't Copy. Go back and try again.
  • Select the "Colors" tab.
  • Select "Color Presets..." -> "Import..."
  • Choose the file $BEDROCK_DIR/config/bedrock.itermcolors
  • Select "Color Presets..." -> "bedrock", which is now available as a choice.
  • Relaunch iTerm2
  • Note: you may have to restart your machine for the shell settings to take effect
  • Uncheck "Load Preferences from a custom folder or URL"

Terminal

  • Open Terminal -> Preferences -> Profiles
  • Import terminal/bedrock.terminal
  • Set dtm as the default

Project structure

  • 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/*.symlink: Any files ending in *.symlink get 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/install.sh: Any files named install.sh will run when script/install is executed.

About

A framework for standardized environment settings (dotfiles) for developers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 52.8%
  • Shell 47.2%