https://github.com/dreadwarrior/dotfiles
yadm managed dotfiles
https://github.com/dreadwarrior/dotfiles
bash dotfiles git homebrew macos manpages
Last synced: 3 months ago
JSON representation
yadm managed dotfiles
- Host: GitHub
- URL: https://github.com/dreadwarrior/dotfiles
- Owner: dreadwarrior
- License: mit
- Created: 2016-04-20T13:07:50.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2025-10-16T20:43:24.000Z (9 months ago)
- Last Synced: 2025-10-17T23:18:01.176Z (9 months ago)
- Topics: bash, dotfiles, git, homebrew, macos, manpages
- Language: HTML
- Homepage: https://dreadwarrior.github.io/dotfiles/
- Size: 248 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotfiles
[yadm][yadm] managed dotfiles.
## Goals
1. Minimal dependency footprint ([yadm][yadm] uses `git` and `bash`)
2. **No** git submodules
## Installation
### Prerequisites: oh-my-zsh
```sh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
```
### Prerequisites: Linux
```sh
sudo apt install yadm
```
### Prerequisites: macOS
```sh
# Install Homebrew + yadm
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install yadm
```
### Clone repository
```sh
cd $HOME
yadm clone git@github.com:dreadwarrior/dotfiles
```
### Optional step: configure YADM on a business machine
```sh
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!](https://sdkman.io/install)
- [go-task](https://taskfile.dev/)
### Update `.local/bin`-commands
- use Posix shell style whenever possible
- consider using [Argbash](https://argbash.io/) if argument and option handling is needed (non-Posix style only :/)
- use `shellcheck` for linting
- don't forget `chmod u+x`
- add [Pandoc compatible](https://pandoc.org/) 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
```sh
cd .local/bin/man
task clean all
```
#### Upgrade gh-pages branch
```sh
MESSAGE='Update documentation' task gh-pages
```
## Links / Notes
- [Upgrade to bash 4 in Mac OS X](http://clubmate.fi/upgrade-to-bash-4-in-mac-os-x/)
- `⌘ CMD`+`⇧ SHIFT`+`.` Reveals hidden files in Open/Save dialogs on Mac OS
- [Spring-Cleaning Homebrew Dependencies](http://patricklenz.co/blog/2012/5/21/spring-cleaning-homebrew-dependencies)
- [Standard Exit Status Codes in Linux](https://www.baeldung.com/linux/status-codes)
[yadm]: https://github.com/TheLocehiliosan/yadm