diff options
author | Ty Dunn <ty@tydunn.com> | 2023-06-03 10:07:36 +0200 |
---|---|---|
committer | Ty Dunn <ty@tydunn.com> | 2023-06-03 10:07:36 +0200 |
commit | 32d99938439b6f8fd9d008f6dc1acee1e3935783 (patch) | |
tree | 582236bf41c173c1c529a5817d45ca64562e1d4f | |
parent | 411060e2557f34c8dc7e378da6fbf859486fbd0a (diff) | |
download | sncontinue-32d99938439b6f8fd9d008f6dc1acee1e3935783.tar.gz sncontinue-32d99938439b6f8fd9d008f6dc1acee1e3935783.tar.bz2 sncontinue-32d99938439b6f8fd9d008f6dc1acee1e3935783.zip |
README updates
-rw-r--r-- | README.md | 75 | ||||
-rw-r--r-- | docs/docs/getting-started.md | 2 | ||||
-rw-r--r-- | docs/docs/install.md | 14 | ||||
-rw-r--r-- | docs/docs/intro.md | 10 | ||||
-rw-r--r-- | docs/docs/walkthroughs/create-a-recipe.md | 2 |
5 files changed, 66 insertions, 37 deletions
@@ -1,49 +1,76 @@ -![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue) +<h1 align="center"> Continue </h1> + +<div align="center"> + +**[Continue](https://continue.dev/docs) is the open-source library for accelerating software development with language models** + +</div> + +<div align="center"> + [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue) ![GitHub Repo stars](https://img.shields.io/github/stars/continuedev/continue?style=social) ![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fcontinuedev%2Fcontinue) -# Continue +</div> -Continue is the open-source autopilot for software developers. Using our SDK you can write short scripts, called recipes, that automate sequences of tasks that are common within your codebase. This repository contains: +## Getting Started -- The Continue Python package, which offers an SDK to write recipes and the Continue server, which runs all automations -- The Continue VSCode extension, where you can natively run recipes and use natural language to refine code much faster +### GitHub Codespaces -**[Read the docs](https://continuedev.netlify.app/)** +Learn how to try the GitHub Codespaces Demo [here](https://continue.dev/docs/getting-started) -# Getting Started +### VS Code -The easiest way to start using Continue is to download our VS Code extension from the marketplace: +Learn how to install locally in VS Code [here](https://continue.dev/docs/install) -[Download for VS Code](https://marketplace.visualstudio.com/items?itemName=Continue.continue) +## Walkthroughs -Alternatively, you can build from source. Just clone the repo and run a Python script: +- [Use the GUI](https://continue.dev/walkthroughs/use-the-gui.md) +- [Use a recipe](https://continue.dev/walkthroughs/use-a-recipe.md) +- [Create a recipe](https://continue.dev/walkthroughs/create-a-recipe.md) +- [Share a recipe](https://continue.dev/walkthroughs/share-a-recipe.md) -```bash -git clone https://github.com/continuedev/continue && cd continue/extension/scripts && python3 install_from_source.py -``` +## How to contribute -# Writing Recipes +### Option 1: Create a recipe and share it with the community -Check out the [recipes folder](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/recipes) to learn how to write your own. +Follow [these steps](https://continue.dev/walkthroughs/share-a-recipe.md) to share a recipe you have created :) -# Contributing +### Option 2: Open a [new GitHub Issue](https://github.com/continuedev/continue/issues/new) or comment on [an existing one](https://github.com/continuedev/continue/issues) -Please do! The easiest way to start contributing is by writing recipes, but PRs/suggestions of all kinds are welcome : ) +Let us know what you would like to contribute and we will help you make it happen! -# Subfolder READMEs +## Install from source -[PyPI Package (Continue Server)](./continuedev) - See here to learn about the Continue Server, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/). +#### 1. Clone this repo -[Continue VS Code Extension](./extension) - See here to learn about the capabilities of our VS Code extension, which is the first implementation of Continue's IDE Protocol, built to be editor-agnostic. A README for developers is found in the [`src/` folder.](./extension/src). +Reccommended: Run this command to use SSH +```bash +git clone git@github.com:continuedev/continue.git +``` + +Alternative: Run this command to use HTTPS +```bash +git clone https://github.com/continuedev/continue +``` + +#### 2. Install Continue -[Continue GUI](./extension/react-app/) - The Continue GUI is a React app that lets users interact with the server. It is made to be placed adjacent to the text editor in your IDE. +Run this command to use the install script +```bash +cd continue/extension/scripts && python3 install_from_source.py +``` -[Docs](./docs) - The source for our documentation. +# Understanding the codebase -[Schema](./schema) - JSON Schema types generated from Pydantic models, used across the `continuedev` and `extension/` directories. +- [Continue Server README](./continuedev): learn about the core of Continue, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/) +- [VS Code Extension README](./extension/src): learn about the capabilities of our extension—the first implementation of Continue's IDE Protocol—which makes it possible to use use Continue in VS Code and GitHub Codespaces +- [Continue GUI README](./extension/react-app/): learn about the React app that lets users interact with the server and is placed adjacent to the text editor in any suppported IDE +- [Schema README](./schema): learn about the JSON Schema types generated from Pydantic models, which we use across the `continuedev/` and `extension/` directories +- [Continue Docs README](./docs): learn how our [docs](https://continue.dev/docs) are written and built # License -[Apache-2.0](<[https://github.com/sestinj/the-x/blob/main/LICENSE](https://opensource.org/licenses/Apache-2.0)>) © 2023 Continue +[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE)
\ No newline at end of file diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index c2c359ad..feca0832 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -22,6 +22,6 @@ If you would like to use Continue locally, you can follow [these steps](./instal If you'd like to continue exploring in GitHub Codespaces, you can learn more with our walkthroughs:
- [Use the GUI](./walkthroughs/use-the-gui.md)
-- [Invoke a recipe](./walkthroughs/use-a-recipe.md)
+- [Use a recipe](./walkthroughs/use-a-recipe.md)
- [Create a recipe](./walkthroughs/create-a-recipe.md)
- [Share a recipe](./walkthroughs/share-a-recipe.md)
\ No newline at end of file diff --git a/docs/docs/install.md b/docs/docs/install.md index 7e36ffd5..a19b2e8c 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -1,22 +1,22 @@ # Installation
:::note
-If you want to try `Continue` before installing, check out the [GitHub Codespaces Demo](./getting-started.md)
+If you want to try Continue before installing locally, check out the [GitHub Codespaces Demo](./getting-started.md)
:::
-## Install `Continue` locally in VS Code
+## Install Continue locally in VS Code
-1. Click `Install` on the `Continue` extension in the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
+1. Click `Install` on the Continue extension in the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
-2. This will open the `Continue` extension page in VS Code, where you will need to click `Install` again
+2. This will open the Continue extension page in VS Code, where you will need to click `Install` again
+
+3. Once you do this, you will see a message in the bottom right hand corner of VS Code that says `Setting up Continue extension...`. After a couple minutes, the Continue extension will then open up. It should look like this when it is complete:
-3. Once you do this, you will see a message in the bottom right hand corner of VS Code that says `Setting up Continue extension...`. After a couple minutes, the `Continue` extension will then open up
-**TODO: Finish writing out this step-by-step**
## How to install from source
-Please follow the [README instructions in the repo](https://github.com/continuedev/continue/blob/main/README.md) to install `Continue` from source.
+Please follow the [README instructions in the repo](https://github.com/continuedev/continue/blob/main/README.md) to install Continue from source.
## Next steps
diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 489d91f6..084f9450 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -4,17 +4,17 @@ ## Quickstart -1. Try out `Continue` in the [GitHub Codespaces Demo](./getting-started.md) -2. Install `Continue` packaged as a [VS Code extension](./install.md) +1. Try out Continue in the [GitHub Codespaces Demo](./getting-started.md) +2. Install Continue packaged as a [VS Code extension](./install.md) ## What is `Continue`? -**`Continue` is the open-source library for accelerating software development with language models** +**Continue is the open-source library for accelerating software development with language models** You define the scenarios where Large Language Models ([LLMs](./concepts/llm.md)) like GPT-4 and StarCoder should act as an autopilot, helping you complete software development tasks. You use [recipes](./concepts/recipe.md) created by others to automate more steps in your workflows. If a [recipe](./concepts/recipe.md) does not exist or work exactly like you want, you can use the [Continue SDK](./concepts/sdk.md) to create custom [steps](./concepts/step.md) and compose them into personalized [recipes](./concepts/recipe.md). Whether you are using a [recipe](./concepts/recipe.md) created by yourself or someone else, you can review, reverse, and rerun [steps](./concepts/step.md) with the [Continue GUI](./concepts/gui.md), which helps you guide the work done by LLMs and learn when to use and trust them. ## Why do developers use `Continue`? -Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and incorporate the generated solutions into your codebase. `Continue` eliminates this pain by deeply integrating LLMs into your IDE amd workflows. +Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and incorporate the generated solutions into your codebase. Continue eliminates this pain by deeply integrating LLMs into your IDE amd workflows. -`Continue` accelerates how developers build, ship, and maintain software, while giving them the control to define when LLMs should take actions and the confidence to trust LLMs. In short, it enables developers to do what they have always done: work together to create better and better abstractions that make it easier and easier to automate the repetitive work that people want computers to do.
\ No newline at end of file +Continue accelerates how developers build, ship, and maintain software, while giving them the control to define when LLMs should take actions and the confidence to trust LLMs. In short, it enables developers to do what they have always done: work together to create better and better abstractions that make it easier and easier to automate the repetitive work that people want computers to do.
\ No newline at end of file diff --git a/docs/docs/walkthroughs/create-a-recipe.md b/docs/docs/walkthroughs/create-a-recipe.md index 12dd3167..6a32906a 100644 --- a/docs/docs/walkthroughs/create-a-recipe.md +++ b/docs/docs/walkthroughs/create-a-recipe.md @@ -1,5 +1,7 @@ # Create a recipe
+Check out the [recipes folder](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/recipes) to learn how to write your own.
+
**TODO: Describe step-by-step how to create a recipe**
Points to include
|