summaryrefslogtreecommitdiff
path: root/.devcontainer/README.md
diff options
context:
space:
mode:
authorRiku Isokoski <riksu9000@gmail.com>2022-08-21 14:50:09 +0300
committerGitHub <noreply@github.com>2022-08-21 14:50:09 +0300
commitc2b6a8de3e15fa66d48a373b3504fcebf12d905b (patch)
tree53e019a0a47d69092dbd02b2a216b66f05a88581 /.devcontainer/README.md
parentc495db8a71675fac3f48f8421b3035b318c3dd82 (diff)
Fix markdown format with autoformatter (#1284)
Diffstat (limited to '.devcontainer/README.md')
-rw-r--r--.devcontainer/README.md25
1 files changed, 10 insertions, 15 deletions
diff --git a/.devcontainer/README.md b/.devcontainer/README.md
index 1932a9d4..b243a64a 100644
--- a/.devcontainer/README.md
+++ b/.devcontainer/README.md
@@ -1,7 +1,6 @@
# VS Code Dev Container
-This is a docker-based interactive development environment using VS Code and Docker Dev Containers removing the need to install any tools locally*
-
+This is a docker-based interactive development environment using VS Code and Docker Dev Containers removing the need to install any tools locally\*
## Requirements
@@ -16,45 +15,41 @@ This is a docker-based interactive development environment using VS Code and Doc
1. Clone InfiniTime and update submodules
2. Launch VS Code
-3. Open InfiniTime directory,
-4. Allow VS Code to open folder with devcontainer.
+3. Open InfiniTime directory,
+4. Allow VS Code to open folder with devcontainer.
-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.
+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.
In order to build InfiniTime we need to run the initial submodule init and CMake commands.
-#### Manually
+#### Manually
- You can use the VS Code terminal to run the CMake commands as outlined in the [build instructions](blob/develop/doc/buildAndProgram.md)
+You can use the VS Code terminal to run the CMake commands as outlined in the [build instructions](blob/develop/doc/buildAndProgram.md)
#### Script
The dev environment comes with some scripts to make this easier, They are located in /opt/.
-There are also VS Code tasks provided should you desire to use those.
+There are also VS Code tasks provided should you desire to use those.
The task "update submodules" will update the git submodules
-
-
### Build
You can use the build.sh script located in /opt/
CMake is also configured and controls for the CMake plugin are available in VS Code
-
-
### Debugging
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.
`openocd -f <yourinterface> -f <nrf52.cfg target file>`
-This will launch OpenOCD in server mode and attach it to the MCU.
+This will launch OpenOCD in server mode and attach it to the MCU.
The default launch.json file expects OpenOCD to be listening on port 3333, edit if needed
-
## Current Issues
-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 \ No newline at end of file
+
+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