Skip to content

Commit 0c4d38b

Browse files
authored
Update README.md
1 parent f3d66c1 commit 0c4d38b

File tree

1 file changed

+72
-39
lines changed

1 file changed

+72
-39
lines changed

README.md

Lines changed: 72 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,95 @@
11
# GitHub Copilot for Vim and Neovim
22

3-
GitHub Copilot is an AI pair programmer tool that helps you write code faster
4-
and smarter. Trained on billions of lines of public code, GitHub Copilot turns
5-
natural language prompts including comments and method names into coding
6-
suggestions across dozens of languages.
3+
> **GitHub Copilot** is your AI-powered coding companion, helping you write code faster and smarter with context-aware suggestions directly in Vim and Neovim.
74
8-
Copilot.vim is a Vim/Neovim plugin for GitHub Copilot.
5+
Copilot.vim brings the capabilities of GitHub Copilot to Vim/Neovim, turning natural language prompts and comments into code suggestions across dozens of programming languages.
96

10-
To learn more, visit
11-
[https://github.com/features/copilot](https://github.com/features/copilot).
7+
- **Official Site:** [GitHub Copilot Features](https://github.com/features/copilot)
8+
- **Plugin Repository:** [github/copilot.vim](https://github.com/github/copilot.vim)
129

13-
## Getting access to GitHub Copilot
10+
---
1411

15-
To access GitHub Copilot, an active GitHub Copilot subscription is required.
16-
Sign up for [GitHub Copilot Free](https://github.com/settings/copilot), or
17-
request access from your enterprise admin.
12+
## 🚀 Features
1813

19-
## Getting started
14+
- Inline AI-powered code suggestions as you type.
15+
- Support for Vim (`9.0.0185+`) and Neovim.
16+
- Easy setup and seamless integration.
17+
- Works with popular plugin managers (vim-plug, lazy.nvim, etc.).
18+
- Accept suggestions with the tab key.
2019

21-
1. Install [Neovim][] or the latest patch of [Vim][] (9.0.0185 or newer).
20+
---
2221

23-
2. Install [Node.js][].
22+
## 📝 Requirements
2423

25-
3. Install `github/copilot.vim` using vim-plug, lazy.nvim, or any other
26-
plugin manager. Or to install manually, run one of the following
27-
commands:
24+
- **Vim:** Version `9.0.0185` or newer
25+
- **Neovim:** Latest release
26+
- **Node.js:** [Download here](https://nodejs.org/en/download/)
27+
- **GitHub Copilot Subscription:** [Sign up here](https://github.com/settings/copilot) or request access from your enterprise admin.
2828

29-
* Vim, Linux/macOS:
29+
---
3030

31-
git clone --depth=1 https://github.com/github/copilot.vim.git \
32-
~/.vim/pack/github/start/copilot.vim
31+
## 📦 Installation
3332

34-
* Neovim, Linux/macOS:
33+
You can use your favorite plugin manager, or install manually:
3534

36-
git clone --depth=1 https://github.com/github/copilot.vim.git \
37-
~/.config/nvim/pack/github/start/copilot.vim
35+
### Using vim-plug (example)
3836

39-
* Vim, Windows (PowerShell command):
37+
```vim
38+
Plug 'github/copilot.vim'
39+
```
4040

41-
git clone --depth=1 https://github.com/github/copilot.vim.git `
42-
$HOME/vimfiles/pack/github/start/copilot.vim
41+
### Manual Installation
4342

44-
* Neovim, Windows (PowerShell command):
43+
**For Vim (Linux/macOS):**
44+
```sh
45+
git clone --depth=1 https://github.com/github/copilot.vim.git \
46+
~/.vim/pack/github/start/copilot.vim
47+
```
4548

46-
git clone --depth=1 https://github.com/github/copilot.vim.git `
47-
$HOME/AppData/Local/nvim/pack/github/start/copilot.vim
49+
**For Neovim (Linux/macOS):**
50+
```sh
51+
git clone --depth=1 https://github.com/github/copilot.vim.git \
52+
~/.config/nvim/pack/github/start/copilot.vim
53+
```
4854

49-
4. Start Vim/Neovim and invoke `:Copilot setup`.
55+
**For Vim (Windows, PowerShell):**
56+
```powershell
57+
git clone --depth=1 https://github.com/github/copilot.vim.git `
58+
$HOME/vimfiles/pack/github/start/copilot.vim
59+
```
5060

51-
[Node.js]: https://nodejs.org/en/download/
52-
[Neovim]: https://github.com/neovim/neovim/releases/latest
53-
[Vim]: https://github.com/vim/vim
61+
**For Neovim (Windows, PowerShell):**
62+
```powershell
63+
git clone --depth=1 https://github.com/github/copilot.vim.git `
64+
$HOME/AppData/Local/nvim/pack/github/start/copilot.vim
65+
```
5466

55-
Suggestions are displayed inline and can be accepted by pressing the tab key.
56-
See `:help copilot` for more information.
67+
---
5768

58-
## Troubleshooting
69+
## ⚡ Getting Started
5970

60-
We’d love to get your help in making GitHub Copilot better! If you have
61-
feedback or encounter any problems, please reach out on our [feedback
62-
forum](https://github.com/github/copilot.vim/issues).
71+
1. Install Vim/Neovim and Node.js (see above).
72+
2. Install Copilot.vim using your preferred method.
73+
3. Start Vim or Neovim.
74+
4. Run `:Copilot setup` to configure the plugin.
75+
5. Start coding! Suggestions will appear inline, and you can accept them by pressing the **Tab** key.
76+
77+
See `:help copilot` in Vim/Neovim for detailed usage.
78+
79+
---
80+
81+
## 💡 Troubleshooting & Feedback
82+
83+
If you have questions, feedback, or encounter issues, please visit our [Feedback Forum](https://github.com/github/copilot.vim/issues).
84+
85+
Help us make GitHub Copilot even better!
86+
87+
---
88+
89+
## 📚 Useful Links
90+
91+
- [Node.js Download](https://nodejs.org/en/download/)
92+
- [Neovim Releases](https://github.com/neovim/neovim/releases/latest)
93+
- [Vim Releases](https://github.com/vim/vim)
94+
95+
---

0 commit comments

Comments
 (0)