You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -14,24 +14,24 @@ This is a docker-based interactive development environment using VSCode and Dock
14
14
15
15
### Code editing, and building.
16
16
17
-
1. Clone InifiniTime and update submodules
18
-
2. Launch VSCode
19
-
3. Open InifiTime directory,
20
-
4. Allow VSCode to open folder with devcontainer.
17
+
1. Clone InfiniTime and update submodules
18
+
2. Launch VS Code
19
+
3. Open InfiniTime directory,
20
+
4. Allow VS Code to open folder with devcontainer.
21
21
22
22
After this the environment will be built if you do not currently have a container setup, it will install all the necessary tools and extra VSCode extensions.
23
23
24
-
In order to build InfiniTime we need to run the initial submodule init and Cmake commands.
24
+
In order to build InfiniTime we need to run the initial submodule init and CMake commands.
25
25
26
26
#### Manually
27
27
28
-
You can use the VSCode terminal to run the CMake commands as outlined in the [build instructions](blob/develop/doc/buildAndProgram.md)
28
+
You can use the VS Code terminal to run the CMake commands as outlined in the [build instructions](blob/develop/doc/buildAndProgram.md)
29
29
30
30
#### Script
31
31
32
-
The dev enviroment comes with some scripts to make this easier, They are located in /opt/.
32
+
The dev environment comes with some scripts to make this easier, They are located in /opt/.
33
33
34
-
There are also VSCode tasks provided should you desire to use those.
34
+
There are also VS Code tasks provided should you desire to use those.
35
35
36
36
The task "update submodules" will update the git submodules
37
37
@@ -41,20 +41,20 @@ The task "update submodules" will update the git submodules
41
41
42
42
You can use the build.sh script located in /opt/
43
43
44
-
CMake is also configured and controlls for the CMake plugin are available in VSCode
44
+
CMake is also configured and controls for the CMake plugin are available in VS Code
45
45
46
46
47
47
48
48
### Debugging
49
49
50
-
Docker on windows does not support passing USB devices to the underlying WSL2 subsystem, To get around this we use openocd in server mode running on the host.
50
+
Docker on windows does not support passing USB devices to the underlying WSL2 subsystem, To get around this we use OpenOCD in server mode running on the host.
This will launch openocd in server mode and attach it to the MCU.
54
+
This will launch OpenOCD in server mode and attach it to the MCU.
55
55
56
-
The default launch.json file expects openocd to be listening on port 3333, edit if needed
56
+
The default launch.json file expects OpenOCD to be listening on port 3333, edit if needed
57
57
58
58
59
59
## Current Issues
60
-
Currently WSL2 Has some real performance issues with IO on a windows host. Accessing files on the virtualized filesystem is much faster. Using VSCodes "clone in container" feature of the Remote - Containers will get around this. After the container is built you will need to update the submodules and follow the build isntructions like normal
60
+
Currently WSL2 Has some real performance issues with IO on a windows host. Accessing files on the virtualized filesystem is much faster. Using VS Codes "clone in container" feature of the Remote - Containers will get around this. After the container is built you will need to update the submodules and follow the build instructions like normal
Copy file name to clipboardExpand all lines: doc/buildWithVScode.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Build and Develop the project using VS Code
2
2
3
-
The .VSCode folder contains configuration files for developing InfiniTime with VS Code. Effort was made to have these rely on Environment variables instead of hardcoded paths.
3
+
The .VS Code folder contains configuration files for developing InfiniTime with VS Code. Effort was made to have these rely on Environment variables instead of hardcoded paths.
4
4
5
5
## Environment Setup
6
6
@@ -22,7 +22,7 @@ We leverage a few VS Code extensions for ease of development.
22
22
23
23
#### Optional Extensions
24
24
25
-
[Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) - ARM Cortex-M GDB Debugger support for VSCode
25
+
[Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) - ARM Cortex-M GDB Debugger support for VS Code
26
26
27
27
Cortex-Debug is only required for interactive debugging using VS Codes built in GDB support.
0 commit comments