Skip to content

Commit 12018dc

Browse files
committed
Update docs
1 parent 9288320 commit 12018dc

2 files changed

Lines changed: 24 additions & 5 deletions

File tree

DEVELOPMENT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ Testing Real-time Suggestions is a little bit different because the Apple Script
3434

3535
Just run both the XPCService and the EditorExtension Target.
3636

37+
## Code Style
38+
39+
We use SwiftFormat to format the code.
40+
41+
The source code mostly follows the [Ray Wenderlich Style Guide](https://github.com/raywenderlich/swift-style-guide) very closely with the following exception:
42+
43+
- Use the Xcode default of 4 spaces for indentation.
44+
3745
## App Versioning
3846

3947
The app version and all targets' version in controlled by `Version.xcconfig`.

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,28 @@ Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing t
2020

2121
## Installation and Setup
2222

23-
1. Download the Copilot for Xcode.app from the latest release, and extract it to the Applications folder.
23+
### Install
24+
25+
1. Download the Copilot for Xcode.app from the latest [release](https://github.com/intitni/CopilotForXcode/releases), and extract it to the Applications folder.
2426
2. Open the app, and click "Set Up Launch Agents" to set up a background running XPC Service that does the real job.
25-
3. Refresh the Copilot status, if it fails, quit and restart the app.
26-
4. Sign in. You will be directed to a verification website provided by GitHub, and a user code will be pasted into your clipboard.
27-
5. After signing in, go back to the app and click "Confirm Sign-in" to finish.
28-
5. Enable the extension in the Settings.app, then maybe restart Xcode.
27+
3. Enable the extension in the Settings.app, then maybe restart Xcode.
28+
29+
### Sign In Github Copilot
30+
31+
1. In the app, refresh the Copilot status, if it fails, quit and restart the app.
32+
2. Click "Sign In", you will be directed to a verification website provided by GitHub, and a user code will be pasted into your clipboard.
33+
3. After signing in, go back to the app and click "Confirm Sign-in" to finish.
2934

3035
The first time the commands run, the extension will ask for 2 types of permissions:
3136
1. Accessibility API: which the extension uses to get the editing file path.
3237
2. Folder Access: the extension needs, to run some Apple Scripts to get the project/workspace path.
3338

39+
## Update
40+
41+
You can manually download the latest release. After updating the app, don't forget to click `Restart XPC Service` in the app to kill the old version and run the new version.
42+
43+
If you want to keep track of the new releases, you can watch this repo's releases to get notifications on updates.
44+
3445
## Commands
3546

3647
- Get Suggestions: Get suggestions for the editing file at the current cursor position.

0 commit comments

Comments
 (0)