diff --git a/README.md b/README.md index 9b8987a..accb5cf 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,12 @@ Let's get started! 🎈 Include a brief description of the features your extension provides. For example: --> -**nova-copilot-lsp** aims to provide deep integration with **Github Copilot**, including the most important features. +**nova-copilot-lsp** aims to provide deep integration with [**Github Copilot**](https://github.com/features/copilot), including the most important features. + + +Right now it is functional, but takes some finagling. If you'd like a deeper integration, [help us out](https://github.com/gobijan/nova-copilot-lsp) or let Github know by [leaving a comment in their discussion.](https://github.com/orgs/community/discussions/7431) +Working copilot language server extracted from [Github's Neovim Copilot Plugin](https://github.com/github/copilot.vim). -Right now it is partly functional but the foundation is there by embedding a working copilot language server extracted from https://github.com/github/copilot.vim ## Requirements @@ -23,16 +26,51 @@ Right now it is partly functional but the foundation is there by embedding a wor 🎈 If your extension depends on external processes or tools that users will need to have, it's helpful to list those and provide links to their installers: --> -nova-copilot-lsp requires some additional tools to be installed on your Mac: -- [Node.js 8.2.0](https://nodejs.org) and NPM 5.2.0 or newer +nova-copilot-lsp requires some additional tools to be installed on your Mac: +- [Node.js](https://nodejs.org) 8.2.0 or newer and NPM 5.2.0 or newer +- [Neovim](https://neovim.io) (used for authentication with GitHub Copilot) > To install the current stable version of Node, click the "Recommended for Most Users" button to begin the download. When that completes, double-click the **.pkg** installer to begin installation. +## Installation + +The following steps are inspired by Github's Docs. [Head over there for more info.](https://github.com/github/copilot.vim?tab=readme-ov-file#getting-started) + +1. Install dependencies: + + ```bash + brew install neovim node + ``` + +2. Clone the Copilot Plugin for Neovim: + + ```bash + git clone https://github.com/github/copilot.vim.git \ + ~/.config/nvim/pack/github/start/copilot.vim + ``` + +3. Start Neovim: + + ```bash + nvim + ``` + +4. Invoke and setup Copilot inside Neovim: + + ```bash + :Copilot setup + ``` + + Follow the prompts, which will ask you to copy a code and press enter. A browser will open and ask you for the code. Enter it. Once the browser says success, close the browser. + +If inline suggestions do not appear to be working, invoke `:Copilot status` inside Neovim to verify Copilot is enabled and not experiencing any issues. + + ## Usage