summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTy Dunn <ty@tydunn.com>2023-09-18 18:20:38 -0700
committerTy Dunn <ty@tydunn.com>2023-09-18 18:20:38 -0700
commit4e31c26e340f9539db949693aac3532f81d8c7e4 (patch)
tree399a2019d4f5a782b6f541410c32a934397fc3a8 /README.md
parent784c00cd693d43ac77059ecf7dd01ac46e9856d6 (diff)
downloadsncontinue-4e31c26e340f9539db949693aac3532f81d8c7e4.tar.gz
sncontinue-4e31c26e340f9539db949693aac3532f81d8c7e4.tar.bz2
sncontinue-4e31c26e340f9539db949693aac3532f81d8c7e4.zip
updating README
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 36 insertions, 15 deletions
diff --git a/README.md b/README.md
index 93065ae0..e136e6a0 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,25 @@
> 🎁 **New!: [Use Code Llama with Continue](https://continue.dev/docs/walkthroughs/codellama)**
+![Continue logo](>c_d.png)
+
<h1 align="center">Continue</h1>
<div align="center">
-**[Continue](https://continue.dev/docs) is the open-source autopilot for software development—a [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Continue.continue) that brings the power of ChatGPT to your IDE**
+**[Continue](https://continue.dev/docs) is the open-source autopilot for software development—an IDE extension that brings the power of ChatGPT to [VS Code](https://marketplace.visualstudio.com/items?itemName=Continue.continue) and more**
</div>
<div align="center">
-[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+<a target="_blank" href="https://opensource.org/licenses/Apache-2.0" style="background:none">
+ <img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" style="height: 36px;" />
+</a>
+<a target="_blank" href="https://continue.dev/docs" style="background:none">
+ <img src="https://img.shields.io/badge/continue_docs-%23BE1B55" style="height: 36px;" />
+</a>
<a target="_blank" href="https://discord.gg/vapESyrFmJ" style="background:none">
-<img src="https://img.shields.io/badge/discord-join-continue.svg?labelColor=191937&color=6F6FF7&logo=discord" />
+ <img src="https://img.shields.io/badge/discord-join-continue.svg?labelColor=191937&color=6F6FF7&logo=discord" style="height: 36px;" />
</a>
![Editing With Continue](readme.gif)
@@ -25,34 +32,48 @@
Highlight sections of code and ask Continue for another perspective
-- “how can I set up a Prisma schema that cascades deletes?”
-- “where in the page should I be making this request to the backend?”
-- “how can I communicate between these iframes?”
+- “what does this forRoot() static function do in nestjs?”
+- “why is the first left join in this query necessary here?”
+- “how do I run a performance benchmark on this rust binary?”
### Edit in natural language
Highlight a section of code and instruct Continue to refactor it
-- “/edit migrate this digital ocean terraform file into one that works for GCP”
-- “/edit change this plot into a bar chart in this dashboard component”
-- “/edit rewrite this function to be async”
+- “/edit rewrite this to return a flattened list from a 3x3 matrix”
+- “/edit refactor these into an angular flex layout on one line"
+- “/edit define a type here for a list of lists of dictionaries”
### Generate files from scratch
Open a blank file and let Continue start new Python scripts, React components, etc.
-- “/edit here is a connector for postgres, now write one for kafka”
-- “/edit make an IAM policy that creates a user with read-only access to S3”
-- “/edit use this schema to write me a SQL query that gets recently churned users”
+- “/edit get me started with a basic supabase edge function”
+- “/edit implement a c++ shortest path algo in a concise way”
+- “/edit create a docker compose file with php and mysql server"
+
+### Understand errors and exceptions
+
+Press `cmd+shift+r` (MacOS) / `ctrl+shift+r` (Windows) when you come across an error or exception in your terminal. This will throw the stack trace into Continue and ask for it to explain the issue to you.
## Getting Started
### [Download for VS Code](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
-By default, Continue uses `GPT-4` and `GPT-3.5-turbo` via the OpenAI API.
+By default, Continue uses `GPT-4` and `GPT-3.5-turbo` via the OpenAI API. You can adjust the config to use different Large Language Models (LLMs), including local, private models. Read more [here](https://continue.dev/docs/customization/models).
+
+### [Run the server manually](https://continue.dev/docs/walkthroughs/manually-run-continue)
+
+You might want to run Continue manually if (a) a firewall, VPN, or other issue is stopping Continue from automatically downloading the server binary, (b) you are on an OS where the binary fails to run (e.g. RHEL8), (c) you are using an air-gapped computer, (d) you want to self-host Continue, or (e) you want to run from source while developing / modifying Continue's code. Read more [here](https://continue.dev/docs/walkthroughs/manually-run-continue#recommended-use-the-continuedev-pypi-package).
+
+### [Run in "headless mode"]()
+
+"Headless mode" allows Continue to run in the background, without needing to be connected to the IDE or GUI. This is useful for performing refactors or other long-running tasks asynchronously. Headless mode can also be run in CI/CD, for example, to perform a thorough review for errors. Read more [here](https://continue.dev/docs/walkthroughs/headless-mode).
+
+## Contributing
-You can adjust the config to use different LLMs, including local, private models. Read more [here](https://continue.dev/docs/customization#change-the-default-llm).
+Check out the [contribution ideas board](https://github.com/orgs/continuedev/projects/2), read the [contributing guide](https://github.com/continuedev/continue/blob/main/CONTRIBUTING.md), and join [#contribute on Discord](https://discord.gg/vapESyrFmJ).
## License
-[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE)
+[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE) \ No newline at end of file