summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorMeco Man <[email protected]>2023-07-29 23:44:05 -0400
committerMeco Man <[email protected]>2023-07-30 00:40:52 -0400
commit9f88f10e826f14b7aa6b74944f96d466694db8da (patch)
tree34462432896715c78df1dec8125a849532966748 /documentation
parente44761c169c71c73acd59240ebece6c0599b2d23 (diff)
[docs] add env vscode document
Diffstat (limited to 'documentation')
-rw-r--r--documentation/env/env-vscode.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/documentation/env/env-vscode.md b/documentation/env/env-vscode.md
new file mode 100644
index 0000000000..5145a9970c
--- /dev/null
+++ b/documentation/env/env-vscode.md
@@ -0,0 +1,17 @@
+# Use Env to Generate VSCode Project
+
+## Preparation
+
+Assume that you have install the Env environment, if not, please read these document first:
+
+- [User Manual of Env](env.md)
+
+## Generate VSCode Project
+
+Go to a specific RT-Thread bsp folder, e.g. `bsp/stm32/stm32f411-st-nucleo`, and open the Env terminal under this directory.
+
+Type `menuconfig` command to configure the BSP, and use `pkgs --update` to download and update software packages if select pacakges and didn't set automatically downloading using `menuconfig -s`.
+
+Then, use `scons --target=vsc` command to generate the VSCode project, and use `code .` command to open the VSCode. Noted that you must execute `code .` under Env terminal to open the VSCode, please don't directly open VSCode because environment variables need to be set automatically for VSCode under Env terminal.
+
+In the VSCode terminal, you can use `scons -j12` to compile the project or edit the project source code.