From d614719ed437cbce80fe937954e6ef647075a969 Mon Sep 17 00:00:00 2001 From: Nate Sesti <33237525+sestinj@users.noreply.github.com> Date: Sun, 28 May 2023 21:01:55 -0400 Subject: Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index dc1ad7de..4c320a8b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,26 @@ # Continue +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: + +- 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 + +## Getting Started + +The easiest way to start using Continue is to download our VS Code extension from the marketplace: + [Download for VS Code](https://marketplace.visualstudio.com/items?itemName=Continue.continue) +Alternatively, you can build from source. Just clone the repo and run a Python script: + +```bash +git clone https://github.com/continuedev/continue && cd continue/extension/scripts && python3 install_from_source.py +``` + +## Writing Recipes + +See our guides on writing recipes in the documentation. + Resources - [Continue Github Project](https://github.com/orgs/continuedev/projects/1/views/1) -- cgit v1.2.3-70-g09d2 From 03be7e716c0737bcfcadabb55be8260fd279d5ed Mon Sep 17 00:00:00 2001 From: Nate Sesti <33237525+sestinj@users.noreply.github.com> Date: Sun, 28 May 2023 21:06:47 -0400 Subject: Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 4c320a8b..cc95445a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue) +[![License: MIT](https://img.shields.io/badge/License-Apache-2.0-yellow.svg)](https://opensource.org/licenses/Apache-2.0) +![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 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: -- cgit v1.2.3-70-g09d2 From d5777cf933b72507c90ffbf9aedc3f737771d615 Mon Sep 17 00:00:00 2001 From: Nate Sesti <33237525+sestinj@users.noreply.github.com> Date: Sun, 28 May 2023 21:08:20 -0400 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc95445a..fb061e2f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ ![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue) -[![License: MIT](https://img.shields.io/badge/License-Apache-2.0-yellow.svg)](https://opensource.org/licenses/Apache-2.0) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![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) -- cgit v1.2.3-70-g09d2 From 61d9e3de9179ca9432689e3dd47009d39b1280e3 Mon Sep 17 00:00:00 2001 From: Nate Sesti Date: Sun, 28 May 2023 21:52:11 -0400 Subject: continuedev README improvements --- continuedev/README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/continuedev/README.md b/continuedev/README.md index 5658e8de..a1ddb084 100644 --- a/continuedev/README.md +++ b/continuedev/README.md @@ -1,27 +1,23 @@ -# Continue +# Continue PyPI Package Continue is a Python library for automating repetitive sequences of software development tasks using language models. Using our VS Code extension, you can build, run, and refine these recipes as they natively interact with your codebase. Download on [our GitHub](https://github.com/continuedev/continue). -## Steps to start +## Continue Server -- `cd continue/continue` +The Continue server acts as a bridge between the Continue React app and your IDE, running your recipes and acting on the codebase. Start it by running the following commands: + +- `cd continuedev` - Make sure packages are installed with `poetry install` - `poetry shell` - `cd ..` -- `python3 -m continuedev.src.continuedev` - -## Steps to generate JSON Schema - -Same up until last step and then `python3 -m continuedev.src.scripts.gen_json_schema`. - -## Start the server +- `python3 -m continuedev.src.continuedev.server.main` -Same steps, then `uvicorn continue.src.server.main:app --reload`. +## Scripts -## To build +`poetry run typegen` to generate JSONSchema .json files from the Pydantic types defined in the `models` directory. -Run `poetry build` and it will output wheel and tarball files in `./dist`. +`poetry build` will output wheel and tarball files in `./dist`. ## Writing Steps -See the `src/continuedev/libs/steps` folder for examples of writing a Continue step. +See the `src/continuedev/libs/steps` folder for examples of writing a Continue step. See our documentation for tutorials. -- cgit v1.2.3-70-g09d2 From 327fb65f70fe4b86965a277bbd7cd75c76113eed Mon Sep 17 00:00:00 2001 From: Nate Sesti <33237525+sestinj@users.noreply.github.com> Date: Sun, 28 May 2023 21:54:49 -0400 Subject: Update README.md --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fb061e2f..0e397b23 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,16 @@ git clone https://github.com/continuedev/continue && cd continue/extension/scrip See our guides on writing recipes in the documentation. -Resources +# Resources - [Continue Github Project](https://github.com/orgs/continuedev/projects/1/views/1) - [Continue User Guide](https://www.notion.so/continue-dev/Continue-User-Guide-1c6ad99887d0474d9e42206f6c98efa4) - [Continue - Mission & Vision](https://continue-dev.notion.site/Continue-a8e41af9801641f79d2c8565907bbd22) + +# Contributing + +Please do + +# License + +[Apache-2.0]([https://github.com/sestinj/the-x/blob/main/LICENSE](https://opensource.org/licenses/Apache-2.0)) © 2023 Continue -- cgit v1.2.3-70-g09d2