Skip to content

Commit 7f2ee62

Browse files
committed
Typos for days
1 parent e9248b2 commit 7f2ee62

2 files changed

Lines changed: 18 additions & 18 deletions

File tree

.devcontainer/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# VScode devcontainer
2-
This is a docker-based interactive development environment using VSCode and Docker Devcontainers removing the need to install any tools locally*
1+
# VS Code Dev Container
2+
This is a docker-based interactive development environment using VS Code and Docker Dev Containers removing the need to install any tools locally*
33

44

55

66
## Requirements
77

8-
- VScode
8+
- VS Code
99
- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension
1010
- Docker
1111
- OpenOCD - For debugging
@@ -14,24 +14,24 @@ This is a docker-based interactive development environment using VSCode and Dock
1414

1515
### Code editing, and building.
1616

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.
2121

2222
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.
2323

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.
2525

2626
#### Manually
2727

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)
2929

3030
#### Script
3131

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/.
3333

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.
3535

3636
The task "update submodules" will update the git submodules
3737

@@ -41,20 +41,20 @@ The task "update submodules" will update the git submodules
4141

4242
You can use the build.sh script located in /opt/
4343

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
4545

4646

4747

4848
### Debugging
4949

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.
5151

5252
`openocd -f <yourinterface> -f <nrf52.cfg target file>`
5353

54-
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.
5555

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
5757

5858

5959
## 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

doc/buildWithVScode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Build and Develop the project using VS Code
22

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.
44

55
## Environment Setup
66

@@ -22,7 +22,7 @@ We leverage a few VS Code extensions for ease of development.
2222

2323
#### Optional Extensions
2424

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
2626

2727
Cortex-Debug is only required for interactive debugging using VS Codes built in GDB support.
2828

0 commit comments

Comments
 (0)