diff options
| author | Riku Isokoski <riksu9000@gmail.com> | 2021-08-17 12:35:29 (GMT) |
|---|---|---|
| committer | Riku Isokoski <riksu9000@gmail.com> | 2021-08-17 12:35:29 (GMT) |
| commit | 5b969ccfa975632606aa0b3dc8165460effb9cc3 (patch) | |
| tree | 38cb0686dd51b5d627ee597a07352e291a004749 /doc/buildWithVScode.md | |
| parent | 7ac6bdfe71f10dd4388da6d3fd29650b072f71f7 (diff) | |
| parent | ee44b6ff4998d6f4d0672c05c1f65c0a9692dc0d (diff) | |
Merge branch 'develop' into update_touch_driver
Diffstat (limited to 'doc/buildWithVScode.md')
| -rw-r--r-- | doc/buildWithVScode.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/buildWithVScode.md b/doc/buildWithVScode.md new file mode 100644 index 0000000..c1df17b --- /dev/null +++ b/doc/buildWithVScode.md @@ -0,0 +1,42 @@ +# Build and Develop the project using VS Code + +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. + +## Environment Setup + +To support as many setups as possible the VS Code configuration files expect there to be certain environment variables to be set. + + Variable | Description | Example +----------|-------------|-------- +**ARM_NONE_EABI_TOOLCHAIN_PATH**|path to the toolchain directory|`export ARM_NONE_EABI_TOOLCHAIN_PATH=/opt/gcc-arm-none-eabi-9-2020-q2-update` +**NRF5_SDK_PATH**|path to the NRF52 SDK|`export NRF5_SDK_PATH=/opt/nRF5_SDK_15.3.0_59ac345` + +## VS Code Extensions + +We leverage a few VS Code extensions for ease of development. + +#### Required Extensions + +- [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) - C/C++ IntelliSense, debugging, and code browsing. +- [CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) - Extended CMake support in Visual Studio Code + +#### Optional Extensions + +[Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) - ARM Cortex-M GDB Debugger support for VS Code + +Cortex-Debug is only required for interactive debugging using VS Codes built in GDB support. + + + +## VS Code/Docker DevContainer + +The .devcontainer folder contains the configuration and scripts for using a Docker dev container for building InfiniTime + +Using the [Remote-Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension is recommended. It will handle configuring the Docker virtual machine and setting everything up. + +More documentation is available in the [readme in .devcontainer](.devcontainer/readme.md) + + + + + |