Skip to content

Commit

Permalink
Add table of contents to README because of all new config sections
Browse files Browse the repository at this point in the history
Signed-off-by: Tomas Slusny <[email protected]>
  • Loading branch information
deathbeam committed Nov 18, 2024
1 parent 9462e89 commit 0cc9b06
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,38 @@
> [!NOTE]
> Plugin was rewritten to Lua from Python. Please check the [migration guide from version 1 to version 2](/MIGRATION.md) for more information.
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Lazy.nvim](#lazy.nvim)
- [Vim-Plug](#vim-plug)
- [Manual](#manual)
- [Post-Installation](#post-installation)
- [Usage](#usage)
- [Commands](#commands)
- [Prompts](#prompts)
- [System Prompts](#system-prompts)
- [Sticky Prompts](#sticky-prompts)
- [Models](#models)
- [Agents](#agents)
- [Contexts](#contexts)
- [Selections](#selections)
- [API](#api)
- [Configuration](#configuration)
- [Default configuration](#default-configuration)
- [Customizing buffers](#customizing-buffers)
- [Tips](#tips)
- [Roadmap (Wishlist)](#roadmap-wishlist)
- [Development](#development)
- [Contributors ✨](#contributors-)

## Prerequisites

Ensure you have the following installed:

- **Neovim stable (0.9.5) or nightly**.

Verify "[Copilot chat in the IDE](https://github.com/settings/copilot)" is enabled.

Optional:

- tiktoken_core: `sudo luarocks install --lua-version 5.1 tiktoken_core`. Alternatively, download a pre-built binary from [lua-tiktoken releases](https://github.com/gptlang/lua-tiktoken/releases)
Expand Down Expand Up @@ -88,10 +114,6 @@ require("CopilotChat").setup {

See @deathbeam for [configuration](https://github.com/deathbeam/dotfiles/blob/master/nvim/.config/nvim/lua/config/copilot.lua#L14)

### Post-Installation

Verify "[Copilot chat in the IDE](https://github.com/settings/copilot)" is enabled.

## Usage

### Commands
Expand Down

0 comments on commit 0cc9b06

Please sign in to comment.