From bfc3ae449350930eab8c8968cda4cd2dee67ad40 Mon Sep 17 00:00:00 2001 From: David Metcalfe Date: Mon, 21 Aug 2023 09:40:42 -0700 Subject: [PATCH] Grammar improvements Improved grammar for better readability. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d2b2103..7961b34 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,17 @@ First of all, we would like to thank **Cursor Team** for their brilliant works. ## What's Cursor? And Why This Extension? -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. +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. +We believe there are more developers actively using Visual Studio Code as their main tool for serious work. 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 have to sign in the Cursor account or configure you own API keys to use this extension. Please refer to the [Custom API Keys](#custom-api-keys) section for details. +You must sign into your Cursor account or configure you own API keys to use this extension. Please refer to the [Custom API Keys](#custom-api-keys) section for details. ### 🌟 **Experimental**: Generate entire projects with the AI 🌟 -We bring the experimental features of Cursor's latest AI-generated projects to CodeCursor. Now you can directly create entire projects through AI in VSCode. +We bring the experimental features of Cursor's latest AI-generated projects to CodeCursor. Now you can directly create entire projects through AI in VS Code. When you have opened a workspace, you will be able to see the `Generate Project` command in the Command Palette. @@ -34,15 +34,15 @@ Just open a document and type `CodeCursor` in Command Palette. You will see the ![Command Palette](./artworks/command-palette.png) -Type your prompt and the code generation will just begin. To edit some existing code, you can also select something before perform this command, when accepting the change, the selected code will be replaced with the generated one. +Type your prompt and the code generation will just begin. To edit some existing code, you can also select something before performing this command. When accepting the change, the selected code will be replaced with the generated one. While code generation is in progress, the following status bar item will be displayed: ![Generating](./artworks/generating.png) -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. +Click on it to cancel the request. Upon completion of code generation, the status bar item will change to a "check mark". You can click it to reopen the generated result at any time. -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: +The generated contents will be live streamed, and shown as a text diff. You can simply apply the changes by clicking the "Accept" button in the notification: ![Completed](./artworks/completed.png) @@ -54,7 +54,7 @@ You can chat with your code just like using ChatGPT. To open the chat panel, cli ## Custom API Keys -Cursor server may become unstable when it's under heavy traffic. You can provide your own OpenAI API keys to have a smoother user experience. You can also choose the model you want to use when a key is set. For details, please refer to the extension configuration. +The Cursor server may become unstable when it's under heavy traffic. You can provide your own OpenAI API keys to have a smoother user experience. You can also choose the model you want to use when a key is set. For details, please refer to the extension configuration. > **Note:** > Your API key will be sent to Cursor server. @@ -64,15 +64,15 @@ Cursor server may become unstable when it's under heavy traffic. You can provide - Due to limitations in the new version of the Cursor API, the automatic continuation ability for long code is currently unavailable. - If you trigger `Generate Project` command multiple times simultaneously, undefined behavior may occur. -To track all issues / file a new issue please go to the Github repo. +To track all issues / file a new issue please go to the GitHub repo. ## Security Consideration -The extension **DOES NOT** collect your code, environment data, or any information that could be used to track you. Additionally, we ensure that the Cursor server will not receive those data either. Only the document you perform code generation against will be uploaded to the Cursor server, and they are responsible for preventing any leaks of your code. +The extension **DOES NOT** collect your code, environment data, or any information that could be used to track you. Additionally, we ensure that the Cursor server will not receive that data either. Only the document you perform code generation against will be uploaded to the Cursor server, and they are responsible for preventing any leaks of your code. ## Contributing -To develop the extension, clone the repository and open it in Visual Studio Code. There are two launch targets: "Run Extension" and "Run Extension (Without Rust)". if you only want to debug or work on the UI parts, then you can select "Run Extension (Without Rust)" for faster build speed. +To develop the extension, clone the repository and open it in Visual Studio Code. There are two launch targets: "Run Extension" and "Run Extension (Without Rust)". If you only want to debug or work on the UI parts, then you can select "Run Extension (Without Rust)" for faster build speed. You are welcome to open Pull Requests at any time. But it's still better to start a discussion before making some epic changes.