Added neogit keybindings to which-key

2026-02-13 22:02:34 +00:00 · 2021-12-12 13:25:48 -05:00
parent f4f89ee5ed
commit 88aac72029
5 changed files with 124 additions and 6 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,104 @@
 # My Dotfiles

 This is my repository for learning dotfiles.
+
+It currently will install homebrew and the following homebrew formula.
+
+```
+fd
+git
+mas
+neovim
+node
+ripgrep
+stow
+swift-format
+zsh
+
+```
+
+It will also install the following homebrew casks in the `~/Applications` directory.
+
+```
+docker
+google-chrome
+iterm2
+microsoft-teams
+obs
+paw
+sketchup-pro
+```
+
+And the following fonts.
+
+```
+font-inconsolata-nerd-font
+
+```
+
+The following applications will be installed from the macOS app store.
+
+```
+pwSafe
+Xcode
+```
+
+The following non-app-store applications will be downloaded for later installation / setup.  These will be placed in `~/Downloads`
+
+```
+Logi Options      # logitech mouse / keyboard settings
+AmazonWorkDocsDrive
+```
+
+## Installation
+
+Clone the repository.
+
+```bash
+git clone https://m-housh/dotfiles.git ~/.dotfiles && \
+  cd ~/.dotfiles
+```
+
+The Makefile includes commands to install dependencies andlink the configuration using `gnu-stow`.
+
+On a fresh system run the following command from the dotfiles root.
+
+```
+make bootstrap
+```
+
+This start by installing homebrew, then install the required homebrew formulas and casks.  Next it will use `gnu-stow` to symlink configuration files to the appropriate locations.  And finally, it will download applications from the `App Store`.
+
+After everything has finished up, you will be able to open `iTerm2` and load the profile which should now be symlinked to `~/.config/macOS/iterm/profile.json`
+
+## Make commands
+
+It is also possible to not do the full bootstrapping.  If you would only like to install homebrew (without any formula or casks) then you can run the following command.
+
+```
+make bootstrap-homebrew
+```
+
+Once homebrew is installed, if you'd like to install the homebrew formula and casks (located in `macOS/.config/macOS/Brewfile`) then you can run the following command.
+
+```
+make bootstrap-brews
+```
+
+To symlink the configuration files only then you can run.
+
+```
+make stow
+```
+
+To download the logitech options application and place in your `~/Downloads` folder, you can run.
+
+```
+make bootstrap-logitech
+```
+
+And finally to download the app store applications run.
+
+```
+make bootstrap-app-store
+```