Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinSilvester committed May 21, 2024
1 parent 4f4661a commit eedb3e7
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit eedb3e7

Please sign in to comment.