The macOSrice (steve's dotfiles)

About this repo
Highlights
Packages Overview
Install these dotfiles
Post-Installation
The make Command
Customize
Additional Resources
License

About this repo

This repository contains my personal dotfiles. They are stored here for convenience so that I may quickly access them on new machines or new installs. Also, others may find some of my configurations helpful in customizing their own dotfiles.

Useful scripts are in ~/.local/bin/
Settings for:
- alacritty (terminal emulator)
- vim (text editor)
- zsh (shell)
- lf (file manager)
- zathura (pdf viewer)
- newsboat (rss reader)
- other stuff like inputrc and more, etc.
I try to minimize what's directly in ~ so:
- All configs that can be in ~/.config/ are.
- Some environmental variables have been set in ~/.zshenv to move configs into ~/.config/

Highlights

Minimal efforts to install everything, using a Makefile
Mostly based around Homebrew, Caskroom, latest Bash + GNU Utils
Great Window management (using Amethyst and Rectangle)
Fast and colored prompt
Updated macOS defaults
Well-organized and easy to customize
Supports both Apple Silicon (M1) and Intel chips

Packages Overview

Homebrew (packages: Brewfile)
homebrew-cask (packages: Caskfile)
Latest Git, Bash 4, Python 3, GNU coreutils, and curl
$EDITOR (and Git editor) is Vim

Install these dotfiles and all dependencies

This repo is managed by a makefile. Run make with no arguments to list all commands that could be executed.

Use Makefile to deploy everything:

make init

On a sparkling fresh installation of macOS:

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

The Xcode Command Line Tools includes git and make (not available on stock macOS). Now there are two options:

Install this repo with curl available:

bash -c "`curl -fsSL https://raw.githubusercontent.com/webpro/dotfiles/master/remote-install.sh`"

This will clone or download, this repo to ~/.dotfiles depending on the availability of git, curl or wget.

Alternatively, clone manually into the desired location:

git clone https://github.com/hghann/osxrice.git ~/.dotfiles

Use the Makefile to install everything listed above, and config (using make):

cd ~/.dotfiles
make init

The installation process in the Makefile is tested on every push and every week in this GitHub Action.

Post-Installation

make macos (set macOS defaults)
make dock (set Dock items)

The `make` command

$ make help
Usage: make <command>

Commands:
    alacritty         Deploy Alacritty configs
    backup            Backup macOS packages using brew
    base              Install base system
    doas              Configure doas
    dock              Apply macOS dock settings
    duti              Setup default applications
    grap              Install grap - a groff preprocessor for drawing graphs
    help              Prints out Make help
    init              Inital deploy dotfiles on osx machine
    install           Install arch linux packages using pacman
    jot               Install jot - a markdown style preprocessor for groff
    lf                Deploy lf configs
    macos             Apply macOS system defaults
    mpd               Deploy mpd configs
    mpv               Deploy mpv configs
    ncmpcpp           Deploy ncmpcpp configs
    pip               Install python packages
    pipbackup         Backup python packages
    pipupdate         Update python packages
    pkg_base          Install base packages plus doas because sudo is bloat
    prog_base         Install base programs
    ssh-key_gen       Generate an SSH key
    sync              Push changes to git repo
    testinit          Test initial deploy dotfiles
    testpath          echo $PATH
    update            Update macOS packages and save packages cache
    vim               Init vim
    vimpull           Updates local vim config
    vimpush           Updates vim repo
    walk              Installs plan9 find SUDO NEEDED
    wm                Deploy window manager configs

Additional Resources

License

The files and scripts in this repository are licensed under the MIT License, which is a very permissive license allowing you to use, modify, copy, distribute, sell, give away, etc. the software. In other words, do what you want with it. The only requirement with the MIT License is that the license and copyright notice must be provided with the software.

hghann/osxrice