.files

These are my dotfiles, there are many like them, but these are mine.

These dotfiles target macOS and Ubuntu and are hand-crafted for my personal usage and comfort. You can use anything you'd like here - but no guarantees they'll suit you as well as they suit me. Check out the unofficial guide to dotfiles on GitHub for more info. My repository is mostly influenced by Lars Kappert's Awesome Dotfiles.

Install

First prepare macOS (if this is a fresh install of the OS or a new laptop):

$ sudo softwareupdate -i -a
$ xcode-select --install

(No additional preparation is required on Ubuntu).

Then clone the repository into ~/.dotfiles and run the install script:

$ git clone [email protected]:bbengfort/dotfiles.git ~/.dotfiles
$ source ~/.dotfiles/install.sh

The install script essentially creates symlinks from the dotfiles repo to expected configuration locations then runs a series of installation scripts that use Homebrew to ensure the correct applications are installed.

On macOS you can restore application and private configuration using Mackup:

$ mackup restore

This will symlink files from dropbox into their correct configuration locations.

Organization

The organization of the dotfiles repository has evolved over time, but basically contains the following:

bin: contains dotfile specific utilities
etc: contains configuration files that are linked on install
git: contains git and GitHub configuration files
install: installation scripts for macOS and Ubuntu
macos: contains macOS defaults and configuration
runcom: run commands, primary entry point dotfiles.
system: contains sub configurations on a per-system basis
ubuntu: contains Ubuntu defaults and configurations
vim: contains configurations and files for vim

Tools

This section contains a (possibly not up-to-date) description of the tools installed on each system type. On all systems the following tools are installed and configured:

Bash 4 + Completions: the shell I've chosen is Bash and I'm going all in on it.
Git + Git-Extras: version control happens with Git and some special sauce is added with Git-Extras.
Go: systems programming happens with the Go programming language.
Fasd: quick access to files and directories from POSIX shells.
jq: is like sed for JSON data, used to slice, filter, map and transform structured data.
ShellCheck: a shell script static analysis tool that gives warnings and suggestions for bash/sh shell scripts.
Tree: a recursive directory listing command that produces a depth-indented, colored listing of files.
ImageMagick: Use ImageMagick to create, edit, compose, or convert bitmap images.

macOS

Homebrew: package manager to install most macOS tools.
Mackup: uses Dropbox to synchronize keys, secrets, macOS application settings, and private rc files.
MacVim: a GUI vim editor for quick file editing from the terminal.
pyenv: lets you easily switch between multiple versions of Python.
pyenv-virtualenv: provides features to manage virtualenvs and conda environments for Python.
dockutil: manages Mac OS X dock items.
coreutils: GNU versions of core utilities.
ERAlchemy: generates Entity Relation (ER) diagrams from databases or from SQLAlchemy models.
wifi-password: get the currently connected WiFi password quickly from the terminal.
Quick Look plugins: useful plugins for making Quick Look more effective
macOS Apps

Ubuntu

This section is currently a work in progress.

Currently exploring Gnome → macOS Keyboard Remap to make keybindings a bit easier when switching back and forth.

bbengfort / dotfiles Goto Github PK

dotfiles's Introduction

.files

Install

Organization

Tools

macOS

Ubuntu

Credits/Resources

dotfiles's People

Contributors

Watchers

dotfiles's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs