diff --git a/README.md b/README.md index 4e4c360..1bbc780 100644 --- a/README.md +++ b/README.md @@ -40,73 +40,6 @@ To update to latest: config update all ``` -- [Bash](https://www.gnu.org/software/bash/) - Default shell. All files found in [.config/bash](.config/bash) are loaded in both login and non-login shells. Local configs added to [.local/bash](.local/bash) will also be loaded. [.config/inputrc](.config/inputrc) improves [Bash](https://www.gnu.org/software/bash/) completion behavior and sets [vi editing mode](https://sanctum.geek.nz/arabesque/vi-mode-in-bash/). -- [Git](https://git-scm.com/) - Version control. Configurations defined in [.config/git](.config/git). Dependencies managed as [submodules](.gitmodules). -- [Hammerspoon](https://www.hammerspoon.org/) - Key bindings for managing macOS applications/windows. See [Hammerspoon](#hammerspoon). -- [Homebrew](https://brew.sh/) - macOS package manager. [bundler](https://github.com/Homebrew/homebrew-bundle) manages packages [.config/Brewfile](.config/Brewfile). Local package dependencies managed by `.local/Brewfile` if it exists. -- [Karabiner-Elements](https://pqrs.org/osx/karabiner/) - Custom key mappings for macOS. See [Karabiner-Elements](#karabiner-elements). -- [kitty](https://sw.kovidgoyal.net/kitty/) - Full-featured GPU-optimized terminal emulator with a readable [configuration file](.config/kitty). -- [tmux](https://github.com/tmux/tmux) - Manages multiple terminal sessions, windows, and panes. Configured in [.config/tmux/tmux.conf](.config/tmux/tmux.conf). -- [Neovim](https://neovim.io/) - Primary text editor/IDE configured in [.config/nvim](.config/nvim). - -## Theme - -I use the [onedark](https://github.com/navarasu/onedark.nvim) theme with [Source Code Pro Nerd Font Mono](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/SourceCodePro). My [tmux status bar](.config/tmux/status-bar.sh) has been inspired by the same theme. [24-bit](https://res.cloudinary.com/jawang35/image/upload/kitty-24-bit.png) and [256-color](https://res.cloudinary.com/jawang35/image/upload/terminal-256-color.png) terminal emulators are supported. - -[![Kitty (24-bit colors)](https://res.cloudinary.com/jawang35/image/upload/kitty-24-bit.png "Kitty (24-bit colors)")](https://res.cloudinary.com/jawang35/image/upload/kitty-24-bit.png) - -## Karabiner-Elements - -Custom [Karabiner-Elements](https://pqrs.org/osx/karabiner/) key bindings configured in [.config/karabiner](.config/karabiner) on macOS: - -- <kbd>Ctrl</kbd> (or <kbd>Fn</kbd>) with <kbd>h</kbd>, <kbd>j</kbd>, <kbd>k</kbd>, <kbd>l</kbd> for vi-like arrow movement. -- Simultaneous <kbd>j</kbd>+<kbd>k</kbd> to escape. <kbd>⇪ Caps Lock</kbd> bound to <kbd>Ctrl</kbd>+<kbd>⌥</kbd>+<kbd>⌘</kbd> to create a <kbd>Hyper</kbd> key for use with [Hammerspoon](#hammerspoon). -- <kbd>Ctrl</kbd>+<kbd>Delete</kbd> mimics <kbd>Fn</kbd>+<kbd>Delete</kbd> (delete forward). -- Ducky (One 2/Mecha) Mini mappings to match Mac keyboard layout. VID/PID changed to work with macOS (https://twitter.com/i/status/1159519887527727106). - -## Hammerspoon - -Lua scripts for [Hammerspoon](http://www.hammerspoon.org/) configuration. [.hammerspoon/init.lua](.hammerspoon/init.lua) is the entrypoint that loads all the other modules. - -<kbd>Hyper</kbd> key is defined as <kbd>Ctrl</kbd>+<kbd>⌥</kbd>+<kbd>⌘</kbd> and is bound to <kbd>⇪ Caps Lock</kbd> using [Karabiner-Elements](#karabiner-elements). <kbd>Hyper</kbd>+<kbd>r</kbd> reloads the Hammerspoon config. - -### Applications - -The following application shortcuts are used: - -| Keys | Application | -|:------------------------------:| ------------- | -| <kbd>Hyper</kbd>+<kbd>\`</kbd> | Kitty | -| <kbd>Hyper</kbd>+<kbd>1</kbd> | Google Chrome | - -#### Application Mode - -<kbd>Hyper</kbd>+<kbd>a</kbd> opens the application mode. <kbd>Esc</kbd> closes the mode. With the mode open, the following keys launch or switch to the corresponding and close the mode: - -| Keys | Application | -|:-----------------------------:| ----------------- | -| <kbd>Hyper</kbd>+<kbd>m</kbd> | Messages | -| <kbd>Hyper</kbd>+<kbd>o</kbd> | Microsoft Outlook | -| <kbd>Hyper</kbd>+<kbd>p</kbd> | 1Password | -| <kbd>Hyper</kbd>+<kbd>s</kbd> | Slack | - -### Window Management - -The following window shortcuts are used: - -| Keys | Action | -|:------------------------------------------:| ------------ | -| <kbd>Hyper</kbd>+<kbd>f</kbd> | Full Screen | -| <kbd>Hyper</kbd>+<kbd>c</kbd> | Center | -| <kbd>Hyper</kbd>+<kbd>h</kbd> | Left Half | -| <kbd>Hyper</kbd>+<kbd>j</kbd> | Bottom Half | -| <kbd>Hyper</kbd>+<kbd>k</kbd> | Top Half | -| <kbd>Hyper</kbd>+<kbd>l</kbd> | Right Half | -| <kbd>Hyper</kbd>+<kbd>⇧</kbd>+<kbd>h</kbd> | Left Screen | -| <kbd>Hyper</kbd>+<kbd>⇧</kbd>+<kbd>j</kbd> | Lower Screen | -| <kbd>Hyper</kbd>+<kbd>⇧</kbd>+<kbd>k</kbd> | Upper Screen | -| <kbd>Hyper</kbd>+<kbd>⇧</kbd>+<kbd>l</kbd> | Right Screen | - ## License © 2016 Jason Wang licensed under the [MIT License](LICENSE).