From 73e0adfce42ba6de965d93650141295a514517eb Mon Sep 17 00:00:00 2001 From: Jason Wang Date: Wed, 29 Nov 2023 20:15:37 -0800 Subject: [PATCH] Remove outdated documentation from README --- README.md | 67 ------------------------------------------------------- 1 file changed, 67 deletions(-) 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: - -- Ctrl (or Fn) with h, j, k, l for vi-like arrow movement. -- Simultaneous j+k to escape. ⇪ Caps Lock bound to Ctrl+⌥+⌘ to create a Hyper key for use with [Hammerspoon](#hammerspoon). -- Ctrl+Delete mimics Fn+Delete (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. - -Hyper key is defined as Ctrl+⌥+⌘ and is bound to ⇪ Caps Lock using [Karabiner-Elements](#karabiner-elements). Hyper+r reloads the Hammerspoon config. - -### Applications - -The following application shortcuts are used: - -| Keys | Application | -|:------------------------------:| ------------- | -| Hyper+\` | Kitty | -| Hyper+1 | Google Chrome | - -#### Application Mode - -Hyper+a opens the application mode. Esc closes the mode. With the mode open, the following keys launch or switch to the corresponding and close the mode: - -| Keys | Application | -|:-----------------------------:| ----------------- | -| Hyper+m | Messages | -| Hyper+o | Microsoft Outlook | -| Hyper+p | 1Password | -| Hyper+s | Slack | - -### Window Management - -The following window shortcuts are used: - -| Keys | Action | -|:------------------------------------------:| ------------ | -| Hyper+f | Full Screen | -| Hyper+c | Center | -| Hyper+h | Left Half | -| Hyper+j | Bottom Half | -| Hyper+k | Top Half | -| Hyper+l | Right Half | -| Hyper+⇧+h | Left Screen | -| Hyper+⇧+j | Lower Screen | -| Hyper+⇧+k | Upper Screen | -| Hyper+⇧+l | Right Screen | - ## License © 2016 Jason Wang licensed under the [MIT License](LICENSE).