From 05fd516d0d29e7eb49d30832fad35f8f8734adc8 Mon Sep 17 00:00:00 2001 From: Graham Hall Date: Sat, 29 Jun 2024 12:20:16 -0400 Subject: [PATCH] actually added details to readme --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8a7e23c..56c2d4e 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,40 @@ My dotfiles for macOS. -## components +## Prerequisites -- **git_config**: +- [Homebrew](https://brew.sh) +- [OhMyZSH](https://github.com/ohmyzsh/ohmyzsh) -- **micro_config** +## Components -- **misc_config** +**git_config** -- **zed_config** +Config for git and the GitHub CLI, as well as my global git ignore -- **zsh_config** +**micro_config** -- **scripts**: various shell scripts I use regularly. They are aliased in `zsh_config` +Settings and keybindings for the [Micro](https://github.com/zyedidia/micro) text editor + +**misc_config** + +Config files that don't fit anywhere else. + +**zed_config** + +Settings and keybindings for the [Zed](https://github.com/zed-industries/zed) text editor + +**zsh_config** + +Configs and aliases for ZSH, as wll as + +**scripts** + +Various shell scripts I use regularly. They are aliased in `zsh_config` + +**Brewfile** + +All formulae and casks I've installed using [Homebrew](https://brew.sh), as well as apps installed from the Mac App Store. Run the `installbrewfile` alias or `brew bundle install --file=~/dotfiles/Brewfile` to install. ## install