From 0cc9b06c00d76062004e73395fb422bac85a24a4 Mon Sep 17 00:00:00 2001 From: Tomas Slusny Date: Mon, 18 Nov 2024 16:31:09 +0100 Subject: [PATCH] Add table of contents to README because of all new config sections Signed-off-by: Tomas Slusny --- README.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5a93ebdc..43e0ccb4 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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