summaryrefslogtreecommitdiff
path: root/extension/scripts/README.md
diff options
context:
space:
mode:
authorNate Sesti <sestinj@gmail.com>2023-06-02 19:45:17 -0400
committerNate Sesti <sestinj@gmail.com>2023-06-02 19:45:17 -0400
commit27be51addfbf146962efed0221c26431353c326a (patch)
tree88e3fd4f32bf02734a79be83d437c5e1cf86b192 /extension/scripts/README.md
parent725b4f00ff6699e0ea52b7bd7bf03398dfa22016 (diff)
parent85b19295941c272f3a6250ecab6126d45d357d6a (diff)
downloadsncontinue-27be51addfbf146962efed0221c26431353c326a.tar.gz
sncontinue-27be51addfbf146962efed0221c26431353c326a.tar.bz2
sncontinue-27be51addfbf146962efed0221c26431353c326a.zip
Merge branch 'docs'
Diffstat (limited to 'extension/scripts/README.md')
-rw-r--r--extension/scripts/README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/extension/scripts/README.md b/extension/scripts/README.md
index 0f851cb4..da1ad493 100644
--- a/extension/scripts/README.md
+++ b/extension/scripts/README.md
@@ -1,5 +1,5 @@
# Scripts
-Whenever we need python to run on the client side, we include a script file at the top level of this folder. All other files that are not to be run directly as a script (utility files) should be in a subfolder of `scripts`. You can call one of these scripts from the VSCode extension using the `runPythonScript` function in `bridge.ts`.
+Whenever we need python to run on the client side, we include a script file at the top level of this folder. All other files that are not to be run directly as a script (utility files) should be in a subfolder of `scripts`. You can call one of these scripts from the VS Code extension using the `runPythonScript` function in `bridge.ts`.
When the extension is activated (`activate` function in `src/extension.ts`), we call `setupPythonEnv`, which makes the virtual environment and downloads all the necessary requirements as given in `requirements.txt`. With this in mind, be sure to run `pip freeze > requirements.txt` whenever you add a new requirement.