summaryrefslogtreecommitdiff
path: root/extension/DEV_README.md
diff options
context:
space:
mode:
authorNate Sesti <sestinj@gmail.com>2023-06-02 14:09:50 -0400
committerNate Sesti <sestinj@gmail.com>2023-06-02 14:09:50 -0400
commit3157898f13a6990aff909e8e4af7f58515a28e8c (patch)
tree773ec943df45a679fa4a0f221b871b7248be50d7 /extension/DEV_README.md
parent6b909caa8dcbd4bf3d1078ded1c12146944ab349 (diff)
parentaea318b48dd7e15df16eca12ba59c677671869aa (diff)
downloadsncontinue-3157898f13a6990aff909e8e4af7f58515a28e8c.tar.gz
sncontinue-3157898f13a6990aff909e8e4af7f58515a28e8c.tar.bz2
sncontinue-3157898f13a6990aff909e8e4af7f58515a28e8c.zip
Merge branch 'main' into docs
Diffstat (limited to 'extension/DEV_README.md')
-rw-r--r--extension/DEV_README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/extension/DEV_README.md b/extension/DEV_README.md
new file mode 100644
index 00000000..7049da45
--- /dev/null
+++ b/extension/DEV_README.md
@@ -0,0 +1,7 @@
+# Continue VS Code Extension
+
+This is the Continue VS Code Extension. Its primary jobs are
+
+1. Implement the IDE side of the Continue IDE protocol, allowing a Continue server to interact natively in an IDE. This happens in `src/continueIdeClient.ts`.
+2. Open the Continue React app in a side panel. The React app's source code lives in the `react-app` directory. The panel is opened by the `continue.openDebugPanel` command, as defined in `src/commands.ts`.
+3. Run a Continue server in the background, which connects to both the IDE protocol and the React app. The server is launched in `src/activation/environmentSetup.ts` by calling Python code that lives in `scripts/` (unless extension settings define a server URL other than localhost:8000, in which case the extension will just connect to that).