Skip to content

Commit 53c088b

Browse files
docs: improve dependencies section organization (#842)
* docs: improve dependencies section organization Reorganize the dependencies section in README.md for better readability: - Split dependencies into required and optional sections - Improve formatting and layout of installation instructions - Clean up wording and presentation of package manager options - Add clearer note about Neovim version compatibility * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent d23a3ca commit 53c088b

1 file changed

Lines changed: 22 additions & 15 deletions

File tree

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,28 @@ https://github.com/user-attachments/assets/8cad5643-63b2-4641-a5c4-68bc313f20e6
1919
# Requirements
2020

2121
- [Neovim 0.10.0+](https://neovim.io/) - Older versions are not officially supported
22-
- [curl](https://curl.se/) - 8.0.0+ is recommended for best compatibility. Should be installed by default on most systems and also shipped with Neovim
23-
- [Copilot chat in the IDE](https://github.com/settings/copilot) setting enabled in GitHub settings
24-
- _Optional_ [tiktoken_core](https://github.com/gptlang/lua-tiktoken) - Used for more accurate token counting
25-
- For Arch Linux users, you can install [`luajit-tiktoken-bin`](https://aur.archlinux.org/packages/luajit-tiktoken-bin) or [`lua51-tiktoken-bin`](https://aur.archlinux.org/packages/lua51-tiktoken-bin) from aur
26-
- Alternatively, install via luarocks: `sudo luarocks install --lua-version 5.1 tiktoken_core`
27-
- Alternatively, download a pre-built binary from [lua-tiktoken releases](https://github.com/gptlang/lua-tiktoken/releases). You can check your Lua PATH in Neovim by doing `:lua print(package.cpath)`. Save the binary as `tiktoken_core.so` in any of the given paths.
28-
- _Optional_ [git](https://git-scm.com/) - Used for fetching git diffs for `git` context
29-
- For Arch Linux users, you can install [`git`](https://archlinux.org/packages/extra/x86_64/git) from the official repositories
30-
- For other systems, use your package manager to install `git`. For windows use the installer provided from git site
31-
- _Optional_ [lynx](https://lynx.invisible-island.net/) - Used for improved fetching of URLs for `url` context
32-
- For Arch Linux users, you can install [`lynx`](https://archlinux.org/packages/extra/x86_64/lynx) from the official repositories
33-
- For other systems, use your package manager to install `lynx`. For windows use the installer provided from lynx site
34-
35-
> [!WARNING]
36-
> If you are on neovim < 0.11.0, you also might want to add `noinsert` and `popup` to your `completeopt` to make the chat completion behave well.
22+
- [curl](https://curl.se/) - Version 8.0.0+ recommended for best compatibility
23+
- [Copilot chat in the IDE](https://github.com/settings/copilot) enabled in GitHub settings
24+
25+
> [!NOTE]
26+
> For Neovim < 0.11.0, add `noinsert` and `popup` to your `completeopt` for proper chat completion behavior.
27+
28+
## Optional Dependencies
29+
30+
- [tiktoken_core](https://github.com/gptlang/lua-tiktoken) - For accurate token counting
31+
32+
- Arch Linux: Install [`luajit-tiktoken-bin`](https://aur.archlinux.org/packages/luajit-tiktoken-bin) or [`lua51-tiktoken-bin`](https://aur.archlinux.org/packages/lua51-tiktoken-bin) from AUR
33+
- Via luarocks: `sudo luarocks install --lua-version 5.1 tiktoken_core`
34+
- Manual: Download from [lua-tiktoken releases](https://github.com/gptlang/lua-tiktoken/releases) and save as `tiktoken_core.so` in your Lua path
35+
36+
- [git](https://git-scm.com/) - For git diff context features
37+
38+
- Arch Linux: Install from official repositories
39+
- Other systems: Use system package manager or official installer
40+
41+
- [lynx](https://lynx.invisible-island.net/) - For improved URL context features
42+
- Arch Linux: Install from official repositories
43+
- Other systems: Use system package manager or official installer
3744

3845
# Installation
3946

0 commit comments

Comments
 (0)