From eedb3e79dbe175421d97db93c02f63717d7975d3 Mon Sep 17 00:00:00 2001 From: Kevin Silvester <kevinsilvester05@gmail.com> Date: Wed, 22 May 2024 00:16:27 +0100 Subject: [PATCH] update readme --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d74043..8b148d1 100644 --- a/README.md +++ b/README.md @@ -55,9 +55,56 @@ --- +### Getting Started + +##### Requirements: + +- <details> + <summary>JetBrainsMono Nerd Font</summary> + + Install with HomeBrew (Linux) + + ```sh + brew tap homebrew/cask-fonts + brew install font-jetbrains-mono-nerd-font + ``` + + Install with Scoop (Windows) + + ```sh + scoop bucket add nerd-font + scoop install JetBrainsMono-NF + ``` + + > More Info: + > + > - <https://www.nerdfonts.com/#home> + > - <https://github.com/ryanoasis/nerd-fonts?#font-installation> + + </details/> + +&nbps; + +##### Steps: + +1. ```sh + # On Windows and Unix systems + git clone https://github.com/KevinSilvester/wezterm-config.git ~/.config/wezterm + ``` +2. And Done!!! 🎉🎉 + +&nbps; + +##### Things You Might Want to Change: + +- [./config/domains.lua](./config/domains.lua) for custom SSH/WSL domains +- [./config/launch.lua](./config/launch.lua) for preferred shells and its paths + +--- + ### All Key Binbdings -Most of the key bindings revolve around a <kbd>SUPER</kbd> and a <kbd>SUPER_REV</kbd>(super reversed) keys.<br> +Most of the key bindings revolve around a <kbd>SUPER</kbd> and <kbd>SUPER_REV</kbd>(super reversed) keys.<br> - On MacOs: - <kbd>SUPER</kbd> ⇨ <kbd>Super</kbd>