Skip to content

Commit 40c2c1d

Browse files
committed
Add README.md
1 parent 73800cb commit 40c2c1d

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

README.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
![Screenshot](/Screenshot.png)
44

5-
Copilot for Xcode is an Xcode Source Editor Extension that provides Github Copilot and ChatGPT support for Xcode. It uses the LSP provided through [Copilot.vim](https://github.com/github/copilot.vim/tree/release/copilot/dist) to generate suggestions and displays them as comments or in a separate window.
6-
7-
Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing the way to interact with Copilot. And thanks to [LanguageClient](https://github.com/ChimeHQ/LanguageClient) for the Language Server Protocol support in Swift.
5+
Copilot for Xcode is an Xcode Source Editor Extension that provides GitHub Copilot and ChatGPT support for Xcode.
86

97
<a href="https://www.buymeacoffee.com/intitni" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
108

@@ -27,7 +25,7 @@ Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing t
2725
- [Granting Permissions to the App](#granting-permissions-to-the-app)
2826
- [Managing `CopilotForXcodeExtensionService.app`](#managing-copilotforxcodeextensionserviceapp)
2927
- [Update](#update)
30-
- [Commands](#commands)
28+
- [Feature](#feature)
3129
- [Key Bindings](#key-bindings)
3230
- [Prevent Suggestions Being Committed](#prevent-suggestions-being-committed)
3331
- [Limitations](#limitations)
@@ -123,10 +121,20 @@ If you are upgrading from a version lower than **0.7.0**, please run `Copilot fo
123121

124122
If you find that some of the features are no longer working, please first try regranting permissions to the app.
125123

126-
## Commands
124+
## Feature
127125

128126
### Suggestion
129127

128+
GitHub Copilot can provide real-time code suggestions based on the files you have opened. It utilizes its knowledge of your codebase to generate helpful suggestions.
129+
130+
If you're working on a company project and don't want the suggestion feature to be triggered, you can globally disable it and choose to enable it only for specific projects.
131+
132+
Whenever you stop typing for a few milliseconds, the app will automatically fetch suggestions for you, you can cancel this by clicking the mouse, or pressing **Escape** or the **arrow keys**.
133+
134+
*: If a file is already open before the helper app launches, you will need to switch to those files in order to send the open file notification.
135+
136+
#### Commands
137+
130138
- Get Suggestions: Get suggestions for the editing file at the current cursor position.
131139
- Next Suggestion: If there is more than one suggestion, switch to the next one.
132140
- Previous Suggestion: If there is more than one suggestion, switch to the previous one.
@@ -136,11 +144,15 @@ If you find that some of the features are no longer working, please first try re
136144
- Real-time Suggestions: Call only by Copilot for Xcode. When suggestions are successfully fetched, Copilot for Xcode will run this command to present the suggestions.
137145
- Prefetch Suggestions: Call only by Copilot for Xcode. In the background, Copilot for Xcode will occasionally run this command to prefetch real-time suggestions.
138146

139-
**About real-time suggestions**
147+
### Chat
140148

141-
Whenever you stop typing for a few milliseconds, the app will automatically fetch suggestions for you, you can cancel this by clicking the mouse, or pressing **Escape** or the **arrow keys**.
149+
This feature is powered by ChatGPT. Please ensure that you have set up your OpenAI account before using it.
142150

143-
### Chat
151+
There are currently two tabs in the chat panel: one is available globally across Xcode, and the other is only available in the current file.
152+
153+
You can detach the chat panel by simply dragging it away. Once detached, the chat panel will remain visible even if Xcode is inactive. To re-attach it to the widget, click the message bubble button located next to the circular widget.
154+
155+
#### Commands
144156

145157
- Chat with Selection: Open a chat window, if there is a selection, the selected code will be added to the prompt.
146158
- Explain Selection: Open a chat window and explain the selected code.
@@ -166,13 +178,15 @@ If you need to end a plugin, you can just type
166178

167179
### Prompt to Code
168180

169-
- Prompt to Code: Open a prompt to code window, where you can use natural language to write or edit selected code.
181+
Refactor selected code or write new code using natural language.
170182

171-
Prompt to code commands are not available in comment mode.
183+
#### Commands
184+
185+
- Prompt to Code: Open a prompt to code window, where you can use natural language to write or edit selected code.
172186

173187
### Custom Commands
174188

175-
You can create custom commands that runs Chat and Prompt to Code with custom prompts. This commands can be accessed from the Xcode menu bar and the context menu of the circular widget.
189+
You can create custom commands that run Chat and Prompt to Code with personalized prompts. These commands are easily accessible from both the Xcode menu bar and the context menu of the circular widget.
176190

177191
## Key Bindings
178192

@@ -217,3 +231,10 @@ fi
217231
## License
218232

219233
MIT.
234+
235+
## What's More
236+
237+
The app uses the LSP provided through [Copilot.vim](https://github.com/github/copilot.vim/tree/release/copilot/dist) to generate suggestions and displays them as comments or in a separate window.
238+
239+
Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing the way to interact with GitHub Copilot. And thanks to [LanguageClient](https://github.com/ChimeHQ/LanguageClient) for the Language Server Protocol support in Swift.
240+

0 commit comments

Comments
 (0)