Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install commands in README #28

Merged
merged 9 commits into from
Oct 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 108 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,118 @@

- ##### Requirements:

- WezTerm `>= 20240127-113634-bbcac864`
- <details>
<summary><b>WezTerm<b></summary>

Minimum Version: `20240127-113634-bbcac864`<br>
Recommended Version: [`Nightly`](https://github.com/wez/wezterm/releases/nightly)

[Official Installation Page](https://wezfurlong.org/wezterm/installation.html)

**Windows**

- <details>
<summary>Install Stable</summary>

- Install with Scoop (non-portable)

```sh
scoop bucket add extras
scoop install wezterm
```

- Install with Scoop (portable)

```sh
scoop bucket add k https://github.com/KevinSilvester/scoop-bucket
scoop install k/wezterm
```

- Install with winget

```sh
winget install wez.wezterm
```

- Install with choco

```sh
choco install wezterm -y
```
</details>

- <details>
<summary>Install Nightly</summary>

- Install with Scoop (non-portable)

```sh
scoop bucket add versions
scoop install wezterm-nightly
```

- Install with Scoop (portable)

```sh
scoop bucket add k https://github.com/KevinSilvester/scoop-bucket
scoop install k/wezterm-nightly
```
</details>

> :bulb:<br>
> Toast notifications don't work in non-portable installations.<br>
> See issue <https://github.com/wez/wezterm/issues/5166> for more details

---

**MacOS**

- <details>
<summary>Install Stable</summary>

- Install with Homebrew

```sh
brew install --cask wezterm
```

- Install with MacPort

```sh
sudo port selfupdate
sudo port install wezterm
```
</details>

- <details>
<summary>Install Nighlty</summary>

- Install with Homebrew

```sh
brew install --cask wezterm@nightly
```

- Upgrade with Homebrew

```sh
brew install --cask wezterm@nightly --no-quarantine --greedy-latest
```
</details>

---

**Linux**

Refer to the Linux installation page.<br>
<https://wezfurlong.org/wezterm/install/linux.html>

</details>

- <details>
<summary>JetBrainsMono Nerd Font</summary>

Install with HomeBrew (Macos)
Install with Homebrew (Macos)

```sh
brew tap homebrew/cask-fonts
Expand All @@ -84,7 +190,6 @@
>
> - <https://www.nerdfonts.com/#home>
> - <https://github.com/ryanoasis/nerd-fonts?#font-installation>

</details/>

&nbsp;
Expand Down