Skip to content

Commit e550180

Browse files
committed
Update README.md
1 parent bc4a105 commit e550180

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

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

33
![ScreenRecording](/ScreenRecording.gif)
44

5-
Copilot for Xcode is an Xcode Source Editor Extension that provides Github Copilot 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.
5+
Copilot for Xcode is an Xcode Source Editor Extension that provides Github Copilot 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.
66

77
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.
88

@@ -69,6 +69,8 @@ Then set it up with the following steps:
6969

7070
The first time the commands are run, the extension will ask for the necessary permissions. (except Input Monitoring, you have to enable it manually)
7171

72+
If you encounter an alert requesting permission that you have previously granted, please remove the permission from the list and add it again to re-grant the necessary permissions.
73+
7274
Or you can grant them manually by going to the `Privacy & Security` tab in `System Settings.app`, and
7375
- Accessibility API: Click `Accessibility`, and drag `CopilotForXcodeExtensionService.app` to the list.
7476
- Input Monitoring (If you need real-time suggestions): Click `Input Monitoring` and drag `CopilotForXcodeExtensionService.app` to the list.
@@ -89,7 +91,7 @@ brew upgrade --cask copilot-for-xcode
8991

9092
Alternatively, You can download the latest version manually from the latest [release](https://github.com/intitni/CopilotForXcode/releases).
9193

92-
If you are upgrading from a version lower than 0.7.0, please run `Copilot for Xcode.app` at least once to let it set up the new launch agent for you.
94+
If you are upgrading from a version lower than 0.8.0, please run `Copilot for Xcode.app` at least once to let it set up the new launch agent for you.
9395

9496
If you want to keep track of the new releases, you can watch the releases of this repo to get notifications about updates.
9597

@@ -108,14 +110,16 @@ If you find that some of the features are no longer working, please first try re
108110

109111
**About real-time suggestions**
110112

111-
The on/off state is persisted, so be sure to turn it off manually when you no longer want it. When real-time suggestion is turned on, a breathing dot will show up next to the mouse pointer or the editing cursor.
113+
The on/off state is persisted, so be sure to turn it off manually when you no longer want it. When real-time suggestion is turned on, a dot will show up next to the text cursor.
112114

113-
Whenever you stop typing for a few seconds, the app will automatically fetch suggestions for you, you can cancel this by clicking the mouse, or pressing **Escape** or the **arrow keys**.
115+
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**.
114116

115-
When a fetch occurs, the dot will have a slightly different animation. If you don't see it, your permissions may not be set correctly.
117+
When a fetch occurs, the dot will play an animation. If you don't see it, your permissions may not be set correctly.
116118

117119
The implementation won't feel as smooth as that of VSCode. The magic behind it is that it will keep calling the command from the menu when you are not typing or clicking the mouse. So it will have to listen to those events, I am not sure if people like it. Hope that next year, Apple can spend some time on Xcode Extensions.
118120

121+
It will be a better experience if you use the "Floating Widget" mode with real-time suggestions turned on.
122+
119123
## Key Bindings
120124

121125
It looks like there is no way to add default key bindings to commands, but you can set them up in `Xcode settings > Key Bindings`.
@@ -132,7 +136,7 @@ A [recommended setup](https://github.com/intitni/CopilotForXcode/issues/14) that
132136

133137
Essentially using `⌥⇧` as the "access" key combination for all bindings.
134138

135-
## Prevent Suggestions Being Committed
139+
## Prevent Suggestions Being Committed (in comment mode)
136140

137141
Since the suggestions are presented as comments, they are in your code. If you are not careful enough, they can be committed to your git repo. To avoid that, I would recommend adding a pre-commit git hook to prevent this from happening.
138142

@@ -150,7 +154,7 @@ fi
150154

151155
- The first run of the extension will be slow. Be patient.
152156
- The extension uses some dirty tricks to get the file and project/workspace paths. It may fail, it may be incorrect, especially when you have multiple Xcode windows running, and maybe even worse when they are in different displays. I am not sure about that though.
153-
- The suggestions are presented as C-style comments, they may break your code if you are editing a JSON file or something.
157+
- The suggestions are presented as C-style comments in comment mode, they may break your code if you are editing a JSON file or something.
154158

155159
## FAQ
156160

0 commit comments

Comments
 (0)