summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTy Dunn <ty@tydunn.com>2023-06-05 09:26:40 +0200
committerTy Dunn <ty@tydunn.com>2023-06-05 09:26:40 +0200
commitdb0c493850d73c9d05f96ce1c5a04fc318c77422 (patch)
treeb3fffe8f5662c7856f537e99214b36da7ad2a246
parentbcd7f8f10f7b85228862140059b67bb670ca67e5 (diff)
downloadsncontinue-db0c493850d73c9d05f96ce1c5a04fc318c77422.tar.gz
sncontinue-db0c493850d73c9d05f96ce1c5a04fc318c77422.tar.bz2
sncontinue-db0c493850d73c9d05f96ce1c5a04fc318c77422.zip
README changes
-rw-r--r--README.md23
-rw-r--r--extension/src/README.md2
2 files changed, 6 insertions, 19 deletions
diff --git a/README.md b/README.md
index 92570126..6429c715 100644
--- a/README.md
+++ b/README.md
@@ -25,22 +25,9 @@ Learn how to try the GitHub Codespaces Demo [here](https://continue.dev/docs/get
Learn how to install locally in VS Code [here](https://continue.dev/docs/install)
-## Walkthroughs
-
-- [Use the GUI](https://continue.dev/docs/walkthroughs/use-the-gui.md)
-- [Use a recipe](https://continue.dev/docs/walkthroughs/use-a-recipe.md)
-- [Create a recipe](https://continue.dev/docs/walkthroughs/create-a-recipe.md)
-- [Share a recipe](https://continue.dev/docs/walkthroughs/share-a-recipe.md)
-
## How to contribute
-### Option 1: Create a recipe and share it with the community
-
-Follow [these steps](https://continue.dev/docs/walkthroughs/share-a-recipe.md) to share a recipe you have created :)
-
-### 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)
-
-Let us know what you would like to contribute and we will help you make it happen!
+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 there, and we will help you make it happen!
## Install from source
@@ -68,13 +55,13 @@ cd continue/extension/scripts && python3 install_from_source.py
# Understanding the codebase
-- [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 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
-- Add steps for development README mention here
+- [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
# License
-[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE)
+[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE) \ No newline at end of file
diff --git a/extension/src/README.md b/extension/src/README.md
index 126a094a..8523ec86 100644
--- a/extension/src/README.md
+++ b/extension/src/README.md
@@ -1,6 +1,6 @@
# Continue VS Code Extension README
-## How to get started with development
+## How to debug the VS Code Extension
1. Clone the Continue repo