Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
unixzii authored and ktiays committed Mar 27, 2023
1 parent 6b10a12 commit cafc5b8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,21 @@

**Use Cursor right in the editor you love!**

First of all, We would like to thank **Cursor Team** for their brilliant works. Please give their [app](https://www.cursor.so) a try!
First of all, we would like to thank **Cursor Team** for their brilliant works. Please give their [app](https://www.cursor.so) a try!

## What's Cursor? And Why This Extension?

Cursor is an AI code editor based on GPT-4. You can write, edit and chat about your code with it. At this time, Cursor is only provided as a dedicated app, and the team currently has no plans to develop extensions for other editors or IDEs.
Cursor is an AI code editor based on OpenAI GPT models. You can write, edit and chat about your code with it. At this time, Cursor is only provided as a dedicated app, and the team currently has no plans to develop extensions for other editors or IDEs.

We believe there are more developers actively use Visual Studio Code as their main tool for serious works. And this is why we built **CodeCursor**. It's not going to replace the Cursor app, but it provides another way to use Cursor.

## Getting Started

You don't need to configure anything before starting using it. Just open a document and type `CodeCursor` in Command Palette. You will see the command below:
You don't need to configure anything before starting using it.

### Code Generation

Just open a document and type `CodeCursor` in Command Palette. You will see the command below:

![Command Palette](./artworks/command-palette.png)

Expand All @@ -22,13 +26,17 @@ While code generation is in progress, the following status bar item will be disp

![Generating](./artworks/generating.png)

Click on it to cancel the request.
Click on it to cancel the request. Upon completion of code generation, the status bar item will change a "check mark". You can click it reopen the generated result at any time.

Upon completion of code generation, the status bar item will change to:
The generated contents will be live streamed, and shown as a text diff. You can simply apply the changes by clicking "Accept" button in the notification:

![Completed](./artworks/completed.png)

Click on it to reopen the generated result at any time.
### Chat

You can chat with your code just like using ChatGPT. To open the chat panel, click "CodeCursor" icon on the Activity Bar. You can ask questions about the currently opened document or a selected piece of text.

![Chat](./artworks/chat.png)

## Known Issues

Expand Down
Binary file added artworks/chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified artworks/completed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cafc5b8

Please sign in to comment.