Skip to content

docs: improved README.md #85

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.

Sign up for GitHub

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

Merged
DrKJeff16 merged 2 commits into from
Oct 15, 2025
Merged

docs: improved README.md #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fdefa1
docs: improved `README.md`
DrKJeff16 Oct 15, 2025
13667b3
chore: update `README.md`
DrKJeff16 Oct 15, 2025
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
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,27 @@

[Roadmap](https://github.com/DrKJeff16/wezterm-types/discussions/48) | [Discussions](https://github.com/DrKJeff16/wezterm-types/discussions)

[WezTerm](https://github.com/wezterm/wezterm) config type annotations for [Lua Language Server](https://luals.github.io/).
This project aims to provide LuaCATS-like [Lua Language Server](https://luals.github.io/) type annotations
for your [WezTerm](https://github.com/wezterm/wezterm) config.

</div>

> [!IMPORTANT]
> While this was made with an aim to be thorough, you should always double-check
> the [WezTerm Lua Reference](https://wezterm.org/config/lua/general.html) for any
> missing or unclear types.

---

<details>
<summary><b><ins>Example in</ins> <a href="https://github.com/neovim/neovim">Neovim</a></b></summary>
<summary><b>Example in <a href="https://github.com/neovim/neovim">Neovim</a></b></summary>
Comment thread
DrKJeff16 marked this conversation as resolved.

https://github.com/user-attachments/assets/02c261ac-5744-4f34-b767-48095386e21b

</details>
<br />
<details>
<summary><b><ins>Example in VSCodium (VSCode)</ins></b></summary>
<summary><b>Example in VSCodium (VSCode)</b></summary>
Comment thread
DrKJeff16 marked this conversation as resolved.

https://github.com/user-attachments/assets/3693aedf-b790-4618-b969-1b712010bd4f

Expand All @@ -43,11 +49,12 @@ https://github.com/user-attachments/assets/3693aedf-b790-4618-b969-1b712010bd4f

## Features

- LuaCATS-like type annotations
- Built-in colorschemes included (`config.color_scheme`)
- Up to date descriptions
- Function overrides annotated
- Function overrides (_e.g. `wezterm.on()`_)
- Neovim support through [`lazydev.nvim`](https://github.com/folke/lazydev.nvim)
- VSCode support by cloning this into `~/.config/wezterm`, and editing your config in that directory
- VSCode/VSCodium support by cloning this into `~/.config/wezterm`, and editing your config in that directory

---

Expand Down