Update Getting Started Guides for compatibility with updated Vcpkg-ce. (#310)

* Merged PR 342104: Adding option for VS to Getting Started Guides (CMakeSettings.json)

Created CMakeSettings.json template and launch.vs.json template in order to allow for building of embedded cmake projects in VS. Also using new postRemoteConnectCommands field in launch.vs.json in order to flash the board.

Related work items: #1362476, #1362477, #1362479, #1362489, #1362490, #1362491

* Merged PR 348557: Removed unnecessary reset flag

Removed unnecessary reset flag from the NXP launch.vs.json debug server args.

* Merged PR 342106: Morphing VS Getting Started Guides to use CMakePresets.json

Changed Getting Started Guide to use CMakePresets.json.

This doesn't break anything in VSCode as the CMakePresets.json has a configured Configure Preset AND Build Preset.

Related work items: #1362481, #1362482, #1362483, #1362484, #1362489, #1362490, #1362491

* remove cmakesettings.json

* Fix broken image links

* removed empty defaults

* removed extra }

* updating GSG with vcpkg

* added note about path

* remove loggingVerbosity until vscode is live

* fix ce to vcpkg-ce or vcpkg

* updated link

* add statement about VS 2022 Preview

* capitalize Preview

Co-authored-by: Alan Leung <34582775+aleun@users.noreply.github.com>
Co-authored-by: Ryan Winter <ryanwinter@outlook.com>

Author: 3 people

MXChip/AZ3166/VS.md

@@ -12,15 +12,17 @@ This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/a
 
  _*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
 
-## Configure Your Development Environment with vcpkg `ce`
+## Configure Your Development Environment with `vcpkg-ce`
 
-This section shows how to configure your development environment with the new vcpkg `ce` tool: `ce`, short for "configure environment", bootstraps project dependencies from a manifest file, `environment.yaml`. This makes it easy to express which compilers and build tools are required by a project. Upon activation, the tools specified by the manifest are added to the path of the current shell. If the tools are not present, `ce` acquires them and installs them to a common location. The `ce` tool runs in user mode without elevation.
+This section shows how to configure your development environment with the new `vcpkg-ce`, short for "configure environment", bootstraps project dependencies from a manifest file, `vcpkg-configuration.json`. This makes it easy to express which compilers and build tools are required by a project. Upon activation, the tools specified by the manifest are added to the path of the current shell. If the tools are not present, `vcpkg-ce` acquires them and installs them to a common location. The `vcpkg-ce` tool runs in user mode without elevation.
 
-> `ce` is in early preview prior to being integrated as a part of `vcpkg`. To report problems or provide feedback, please open issues at https://github.com/microsoft/vcpkg-ce.
+> `vcpkg-ce` is in early preview. To report problems or provide feedback, please open issues at https://github.com/microsoft/vcpkg-ce.
 
 ### Windows 10
 
-1. Download and install [Visual Studio](https://visualstudio.microsoft.com/downloads/).
+1. Download and install [Visual Studio](https://visualstudio.microsoft.com/downloads/). 
+
+    > The Preview version of VS 2022 will have new embedded features. 
 
 1. Download and install the [ST-LINK Drivers](https://www.st.com/en/development-tools/stsw-link009.html). Restart your computer after installation is complete.
 
@@ -34,22 +36,16 @@ This section shows how to configure your development environment with the new vc
 
     > *getting-started\MXChip\AZ3166*
 
-1. Install `ce`.
-
-    ```PowerShell
-    iex (iwr -useb aka.ms/install-ce.ps1)
-    ```
-
-1. Review the end-user license agreement at https://aka.ms/vcpkg-ce-eula.txt. Run the following command to accept.
+1. Install `vcpkg-ce`.
 
     ```PowerShell
-    ce --accept-eula
+    iex (iwr -useb aka.ms/install-vcpkg.ps1)
     ```
 
 1. Download, install, and activate developer tools.
 
     ```PowerShell
-    ce activate
+    vcpkg activate
     ```
 
 1. Run the following code to confirm that CMake version 3.20 or later is installed.
@@ -64,12 +60,15 @@ This section shows how to configure your development environment with the new vc
 
 1. Connect the Micro USB cable from the DevKit to your computer. If it is already connected, disconnect and reconnect it.
 
-1. Launch Visual Studio.
+1. Launch Visual Studio from a Powershell terminal.
 
-    ```Shell
+    ```PowerShell
     start devenv .
     ```
 
+    > Note that if you have more than one version of Visual Studio installed this may not launch the current preview. In that case you will need to use the full path to your preview installation. For example: 
+    "C:\Program Files\Microsoft Visual Studio\2022\Preview\Common7\IDE\devenv"
+
 1. Ensure that both the Configure Preset and the Build Preset are set to "arm-gcc-cortex-m4"
     
     ![configuration-choice](../../docs/media/vs-preset-configuration-m4.png)
@@ -86,14 +85,14 @@ This section shows how to configure your development environment with the new vc
 
 ## Restoring Your Development Environment
 
-`ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:
+`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:
 
-1. Open a new terminal.
+1. Open a new PowerShell terminal.
 
-1. Re-activate `ce`.
+1. Re-activate `vcpkg-ce`.
 
     ```Shell
-    . ~/.ce/ce activate
+    . ~/.vcpkg/vcpkg activate
     ```
 
 1. Launch Visual Studio.

MXChip/AZ3166/environment.yaml

@@ -0,0 +1,16 @@
+{
+  "registries": [
+    {
+      "name": "microsoft",
+      "location": "https://aka.ms/vcpkg-ce-default",
+      "kind": "artifact"
+    }
+  ],
+  "requires": {
+    "microsoft:compilers/arm/gcc": "* 2020.10.0",
+    "microsoft:tools/compuphase/termite": "* 3.4.0",
+    "microsoft:tools/microsoft/openocd": "* 0.11.0",
+    "microsoft:tools/kitware/cmake": "* 3.20.1",
+    "microsoft:tools/ninja-build/ninja": "* 1.10.2"
+  }
+}

MXChip/AZ3166/vcpkg-configuration.json

@@ -12,11 +12,11 @@ This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/a
 
  _*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
 
-## Configure Your Development Environment with vcpkg `ce`
+## Configure Your Development Environment with `vcpkg-ce`
 
-This section shows how to configure your development environment with the new vcpkg `ce` tool: `ce`, short for "configure environment", bootstraps project dependencies from a manifest file, `environment.yaml`. This makes it easy to express which compilers and build tools are required by a project. Upon activation, the tools specified by the manifest are added to the path of the current shell. If the tools are not present, `ce` acquires them and installs them to a common location. The `ce` tool runs in user mode without elevation.
+This section shows how to configure your development environment with the new `vcpkg-ce`, short for "configure environment", bootstraps project dependencies from a manifest file, `vcpkg-configuration.json`. This makes it easy to express which compilers and build tools are required by a project. Upon activation, the tools specified by the manifest are added to the path of the current shell. If the tools are not present, `vcpkg-ce` acquires them and installs them to a common location. The `vcpkg-ce` tool runs in user mode without elevation.
 
-> `ce` is in early preview prior to being integrated as a part of `vcpkg`. To report problems or provide feedback, please open issues at https://github.com/microsoft/vcpkg-ce.
+> `vcpkg-ce` is in early preview. To report problems or provide feedback, please open issues at https://github.com/microsoft/vcpkg-ce.
 
 ### Windows 10
 
@@ -34,22 +34,16 @@ This section shows how to configure your development environment with the new vc
 
     > *getting-started\MXChip\AZ3166*
 
-1. Install `ce`.
+1. Install `vcpkg-ce`.
 
     ```PowerShell
-    iex (iwr -useb aka.ms/install-ce.ps1)
-    ```
-
-1. Review the end-user license agreement at https://aka.ms/vcpkg-ce-eula.txt. Run the following command to accept.
-
-    ```PowerShell
-    ce --accept-eula
+    iex (iwr -useb aka.ms/install-vcpkg.ps1)
     ```
 
 1. Download, install, and activate developer tools.
 
     ```PowerShell
-    ce activate
+    vcpkg activate
     ```
 
 1. Run the following code to confirm that CMake version 3.20 or later is installed.
@@ -80,22 +74,16 @@ This section shows how to configure your development environment with the new vc
     sudo apt install curl libncurses5
     ```
 
-1. Install `ce`.
+1. Install `vcpkg-ce`.
 
     ```Shell
     . <(curl aka.ms/install-ce.sh -L)
     ```
 
-1. Review the end-user license agreement at https://aka.ms/vcpkg-ce-eula.txt. Run the following command to accept.
-
-    ```Shell
-    ce --accept-eula
-    ```
-
 1. Download, install, and activate developer tools.
 
     ```Shell
-    ce activate
+    vcpkg activate
     ```
 
 1. Ensure the following lines in *getting-started\MXChip\AZ3166\.vscode\tasks.json* have been commented out.
@@ -122,9 +110,9 @@ This section shows how to configure your development environment with the new vc
 
 1. Connect the Micro USB cable from the DevKit to your computer. If it is already connected, disconnect and reconnect it.
 
-1. Launch Visual Studio Code.
+1. Launch Visual Studio Code from a PowerShell terminal.
 
-    ```Shell
+    ```PowerShell
     code .
     ```
 
@@ -158,14 +146,14 @@ This section shows how to configure your development environment with the new vc
 
 ## Restoring Your Development Environment
 
-`ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:
+`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:
 
-1. Open a new terminal.
+1. Open a new PowerShell terminal.
 
-1. Re-activate `ce`.
+1. Re-activate `vcpkg-ce`.
 
     ```Shell
-    . ~/.ce/ce activate
+    . ~/.vcpkg/vcpkg activate
     ```
 
 1. Launch Visual Studio Code.

MXChip/AZ3166/vscode.md

@@ -12,16 +12,18 @@ This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/a
 
  _*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
 
-## Configure Your Development Environment with vcpkg `ce`
+## Configure Your Development Environment with `vcpkg-ce`
 
-This section shows how to configure your development environment with the new vcpkg `ce` tool: `ce`, short for "configure environment", bootstraps project dependencies from a manifest file, `environment.yaml`. This makes it easy to express which compilers and build tools are required by a project. Upon activation, the tools specified by the manifest are added to the path of the current shell. If the tools are not present, `ce` acquires them and installs them to a common location. The `ce` tool runs in user mode without elevation.
+This section shows how to configure your development environment with the new `vcpkg-ce`, short for "configure environment", bootstraps project dependencies from a manifest file, `vcpkg-configuration.json`. This makes it easy to express which compilers and build tools are required by a project. Upon activation, the tools specified by the manifest are added to the path of the current shell. If the tools are not present, `vcpkg-ce` acquires them and installs them to a common location. The `vcpkg-ce` tool runs in user mode without elevation.
 
-> `ce` is in early preview prior to being integrated as a part of `vcpkg`. To report problems or provide feedback, please open issues at https://github.com/microsoft/vcpkg-ce.
+> `vcpkg-ce` is in early preview. To report problems or provide feedback, please open issues at https://github.com/microsoft/vcpkg-ce.
 
 ### Windows 10
 
 1. Download and install [Visual Studio](https://visualstudio.microsoft.com/downloads/).
 
+    > The Preview version of VS 2022 will have new embedded features. 
+
 1. Download and install the [SEGGER J-Link Software and Documentation Pack](https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack) V7.00 or greater. _Note: Version V7.00 or greater is required to support the on-board DAPLink probe._
 
 1. Open an Administrator PowerShell terminal and enable execution of PowerShell scripts.
@@ -40,22 +42,16 @@ This section shows how to configure your development environment with the new vc
 
     > *getting-started\NXP\MIMXRT1060-EVK*
 
-1. Install `ce`.
-
-    ```PowerShell
-    iex (iwr -useb aka.ms/install-ce.ps1)
-    ```
-
-1. Review the end-user license agreement at https://aka.ms/vcpkg-ce-eula.txt. Run the following command to accept.
+1. Install `vcpkg-ce`.
 
     ```PowerShell
-    ce --accept-eula
+    iex (iwr -useb aka.ms/install-vcpkg.ps1)
     ```
 
 1. Download, install, and activate developer tools.
 
     ```PowerShell
-    ce activate
+    vcpkg activate
     ```
 
 1. Run the following code to confirm that CMake version 3.20 or later is installed.
@@ -70,12 +66,15 @@ This section shows how to configure your development environment with the new vc
 
 1. Connect the Micro USB cable from the DevKit to your computer. If it is already connected, disconnect and reconnect it.
 
-1. Launch Visual Studio.
+1. Launch Visual Studio from a PowerShell terminal.
 
-    ```Shell
+    ```PowerShell
     start devenv .
     ```
 
+    > Note that if you have more than one version of Visual Studio installed this may not launch the current preview. In that case you will need to use the full path to your preview installation. For example: 
+    "C:\Program Files\Microsoft Visual Studio\2022\Preview\Common7\IDE\devenv"
+
 1. Ensure that both the Configure Preset and the Build Preset are set to "arm-gcc-cortex-m7"
     
     ![configuration-choice](../../docs/media/vs-preset-configuration-m7.png)
@@ -92,14 +91,14 @@ This section shows how to configure your development environment with the new vc
 
 ## Restoring Your Development Environment
 
-`ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:
+`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:
 
-1. Open a new terminal.
+1. Open a new PowerShell terminal.
 
-1. Re-activate `ce`.
+1. Re-activate `vcpkg-ce`.
 
     ```Shell
-    . ~/.ce/ce activate
+    . ~/.vcpkg/vcpkg activate
     ```
 
 1. Launch Visual Studio.

NXP/MIMXRT1060-EVK/VS.md

@@ -0,0 +1,16 @@
+{
+  "registries": [
+    {
+      "name": "microsoft",
+      "location": "https://aka.ms/vcpkg-ce-default",
+      "kind": "artifact"
+    }
+  ],
+  "requires": {
+    "microsoft:compilers/arm/gcc": "* 2020.10.0",
+    "microsoft:tools/compuphase/termite": "* 3.4.0",
+    "microsoft:tools/microsoft/openocd": "* 0.11.0",
+    "microsoft:tools/kitware/cmake": "* 3.20.1",
+    "microsoft:tools/ninja-build/ninja": "* 1.10.2"
+  }
+}