From 144d649bd30e5185dbec5730eedc8da11eaf710d Mon Sep 17 00:00:00 2001 From: Arne Einecke <47402928+watertrainer@users.noreply.github.com> Date: Wed, 6 Apr 2022 11:37:46 +0100 Subject: [PATCH 1/2] Documentation for building on Windows (see #1056) --- docs/build-flash-and-debug/index.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/build-flash-and-debug/index.md b/docs/build-flash-and-debug/index.md index 171e4bb4..951f6477 100644 --- a/docs/build-flash-and-debug/index.md +++ b/docs/build-flash-and-debug/index.md @@ -172,8 +172,10 @@ docker image build -t infinitime-build --build-arg PUID=$(id -u) --build-arg PGI 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. +At the moment building using VSCode on Windows is not supported. Use the [devcontainer](#vs-codedocker-devcontainer) #### 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 @@ -218,6 +220,20 @@ To use the DevContainer configuration on Ubuntu based systems two changes need t ``openocd -f interface/stlink.cfg -f target/nrf52.cfg``. This launches openocd with the default ports ``3333``, ``4444`` and ``6666``. 4. In VsCode go to the Debug pane on the left of the screen and select the configuration ``Debug - Openocd docker Remote`` and hit the play button on the left. +##### Dev Container on Windows + +To use the DevContainer configuration on Windows a few files need their line endings changed, e.g. by using [notepad++](https://notepad-plus-plus.org/) + +``` +\InfiniTime\tools\mcuboot\imgtool.py +\InfiniTime\tools\mcuboot\imgtool_init_.py +\InfiniTime\tools\mcuboot\imgtool\boot_record.py +\InfiniTime\tools\mcuboot\imgtool\image.py +\InfiniTime\tools\mcuboot\imgtool\version.py +``` + +You also need to install ```cbor``` with ```pip install cbor``` or by running ```pip install -r requirements.txt``` in ```\Infitime\tools\mcuboot```. + ## Build the documentation ### Setup The documentation is written in Markdown (.md) files and generated using the Sphinx documentation generator. From 35aca55fcdcafdc5c142a43fcbb106f0a7c7e623 Mon Sep 17 00:00:00 2001 From: Arne Einecke <47402928+watertrainer@users.noreply.github.com> Date: Wed, 6 Apr 2022 16:44:38 +0100 Subject: [PATCH 2/2] Clarification on no Windows support --- docs/build-flash-and-debug/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-flash-and-debug/index.md b/docs/build-flash-and-debug/index.md index 951f6477..a5e0dab9 100644 --- a/docs/build-flash-and-debug/index.md +++ b/docs/build-flash-and-debug/index.md @@ -172,7 +172,7 @@ docker image build -t infinitime-build --build-arg PUID=$(id -u) --build-arg PGI 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. -At the moment building using VSCode on Windows is not supported. Use the [devcontainer](#vs-codedocker-devcontainer) +At the moment building using VSCode on Windows has not been done yet. Using the [devcontainer](#vs-codedocker-devcontainer) is probably the easiest way. #### Environment Setup