From 5430391a9094ac546046075b7a1a603d6c90067c Mon Sep 17 00:00:00 2001 From: Nate Sesti Date: Fri, 2 Jun 2023 21:29:04 -0400 Subject: READMEs --- README.md | 26 ++++++++++++++++---------- continuedev/README.md | 4 +++- continuedev/pyproject.toml | 2 +- docs/README.md | 3 +++ 4 files changed, 23 insertions(+), 12 deletions(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 0e397b23..1369dfe0 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Continue is the open-source autopilot for software developers. Using our SDK you - 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 +# Getting Started The easiest way to start using Continue is to download our VS Code extension from the marketplace: @@ -22,20 +22,26 @@ Alternatively, you can build from source. Just clone the repo and run a Python s git clone https://github.com/continuedev/continue && cd continue/extension/scripts && python3 install_from_source.py ``` -## Writing Recipes +# Writing Recipes -See our guides on writing recipes in the documentation. +Check out our [recipes repo](https://github.com/continuedev/recipes) to learn how to write your own. -# Resources +# Contributing -- [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) +Please do! The easiest way to start contributing is by writing recipes, but PRs/suggestions of all kinds are welcome : ) -# Contributing +# Subfolder READMEs + +[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/). + +[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). + +[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. + +[Docs](./docs) - The source for our documentation. -Please do +[Schema](./schema) - JSON Schema types generated from Pydantic models, used across the `continuedev` and `extension/` directories. # 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](<[https://github.com/sestinj/the-x/blob/main/LICENSE](https://opensource.org/licenses/Apache-2.0)>) © 2023 Continue diff --git a/continuedev/README.md b/continuedev/README.md index a1ddb084..e27cf3ae 100644 --- a/continuedev/README.md +++ b/continuedev/README.md @@ -1,6 +1,8 @@ # 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). +This package contains the [Continue](https://github.com/continuedev.com/continue) server and core classes needed to build your own recipes. + +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. Read the docs [here](https://continuedev.netlify.app/) or download the VS Code extension [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue). ## Continue Server diff --git a/continuedev/pyproject.toml b/continuedev/pyproject.toml index 0dc4d267..83a287c8 100644 --- a/continuedev/pyproject.toml +++ b/continuedev/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "continuedev" -version = "0.1.0" +version = "0.1.1" description = "" authors = ["Nate Sesti "] readme = "README.md" diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..6bd05ca4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +# Continue Docs + +Markdown content exists in the `docs/` folder, nested as it will be shown in the sidebar. `docusaurus.config.js` defines important footer, sidebar, and title content for the site. -- cgit v1.2.3-70-g09d2