diff options
| author | Ty Dunn <ty@tydunn.com> | 2023-06-29 09:41:34 -0700 |
|---|---|---|
| committer | Ty Dunn <ty@tydunn.com> | 2023-06-29 09:41:34 -0700 |
| commit | 152b10507f42184cc0822c860308a355943b494f (patch) | |
| tree | a2a3b8331282f9f5bac97ec89b0d5219547bbf46 /continuedev | |
| parent | 479cacba2ee9e6baa6e2564ff507ff6f328f0bd3 (diff) | |
| download | sncontinue-152b10507f42184cc0822c860308a355943b494f.tar.gz sncontinue-152b10507f42184cc0822c860308a355943b494f.tar.bz2 sncontinue-152b10507f42184cc0822c860308a355943b494f.zip | |
docs update in root
Diffstat (limited to 'continuedev')
| -rw-r--r-- | continuedev/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/continuedev/README.md b/continuedev/README.md index 911d467d..528cf75a 100644 --- a/continuedev/README.md +++ b/continuedev/README.md @@ -24,3 +24,40 @@ Start it by running the following commands: ## Writing Steps See the `src/continuedev/libs/steps` folder for examples of writing a Continue step. See our documentation for tutorials. + +## How to contribute + +Open a [new GitHub Issue](https://github.com/continuedev/continue/issues/new) or comment on [an existing one](https://github.com/continuedev/continue/issues). Let us know what you would like to contribute, and we will help you make it happen! + +## Install from source + +#### 1. Clone this repo + +Recommended: 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 + +Run this command to use the install script + +```bash +cd continue/extension/scripts && python3 install_from_source.py +``` + +# Understanding the codebase + +- [Continue Server README](./continuedev/README.md): learn about the core of Continue, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/) +- [VS Code Extension README](./extension/README.md): 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 +- [How to debug the VS Code Extension README](./extension/src/README.md): learn how to set up the VS Code extension, so you can debug it
\ No newline at end of file |