Skip to content

dreadwarrior/dotfiles

Repository files navigation

dotfiles

yadm managed dotfiles.

Goals

  1. Minimal dependency footprint (yadm uses git and bash)
  2. No git submodules

Installation

Prerequisites: oh-my-zsh

sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

Prerequisites: Linux

sudo apt install yadm

Prerequisites: macOS

# Install Homebrew + yadm
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install yadm

Clone repository

cd $HOME
yadm clone git@github.com:dreadwarrior/dotfiles

Optional step: configure YADM on a business machine

yadm config local.class work
yadm alt

Now restart your terminal session.

Development

Requirements

  • Pandoc, e.g. via Homebrew brew install pandoc
  • ShellCheck, e.g. via Homebrew brew install shellcheck
  • JBang, e.g. via SDKMAN!
  • go-task

Update .local/bin-commands

  • use Posix shell style whenever possible
  • consider using Argbash if argument and option handling is needed (non-Posix style only :/)
  • use shellcheck for linting
  • don't forget chmod u+x
  • add Pandoc compatible man page markdown source in /man subdirectory
  • optional:
    • adjust dotfiles_commands.7.md with link to new man page
    • adjust index.md with link to new man page

Build man pages

cd .local/bin/man
task clean all

Upgrade gh-pages branch

task gh-pages

Links / Notes

Releases

No releases published

Packages

No packages published