Update file(s) from Arm-Debug/vscode-keil-studio-pack

README.md

@@ -4,13 +4,19 @@
 
 The **Keil Studio Pack** installs recommended extensions for embedded and IoT software development on Arm-based microcontroller (MCU) devices. The extensions included are listed in the **Details** of the pack in Visual Studio Code and described in [Extensions available in the pack](#extensions-available-in-the-pack).
 
-We recommend installing the **Keil Studio Pack** in Visual Studio Code desktop to quickly set up your environment and start working with an example.
+We recommend installing the **Keil Studio Pack** in Visual Studio Code Desktop to quickly set up your environment and start working with an example.
 
 The main Keil Studio extensions available with the pack are **Arm CMSIS csolution**, **Arm Device Manager** and **Arm Embedded Debugger**. The extensions enable you to manage CMSIS solutions (csolution projects), run projects on a hardware and undertake debugging. The extensions can be used together or individually.
 
-**Note**: The **Arm CMSIS csolution** and **Arm Environment Manager** extensions are not supported in Visual Studio Code for the Web.
+A pre-release of the **Keil Studio Pack** is also available and includes all the main extensions included in the offical pack and **Arm Debugger**, instead of **Arm Embedded Debugger**. The pre-release also includes the **Memory Inspector** and **Peripheral Inspector** extensions.
 
-This Readme explains how to install the extensions with Visual Studio Code desktop. When you have installed the pack, read the documentation available on Arm Developer to [get started with an example project](https://developer.arm.com/documentation/108029/latest/Get-started-with-an-example-project).
+This Readme explains how to install the extensions with Visual Studio Code Desktop. When you have installed the pack, read the documentation available on Arm Developer to [get started with an example project](https://developer.arm.com/documentation/108029/latest/Get-started-with-an-example-project).
+
+## Intended use cases for the extensions
+
+- **Embedded and IoT software development using CMSIS-Packs and csolution projects**: The "Common Microcontroller Software Interface Standard" (CMSIS) provides driver, peripheral and middleware support for thousands of MCUs and hundreds of development boards. Using the csolution project format, you can incorporate any CMSIS-Pack based device, board, and software component into your application. For more information about supported hardware for CMSIS projects, go to the [Boards](https://www.keil.arm.com/boards/) and [Devices](https://www.keil.arm.com/devices/) pages on keil.arm.com. For information about CMSIS-Packs, go to [open-cmsis-pack.org](https://www.open-cmsis-pack.org/index.html).
+
+- **Enhancement of a pre-existing Visual Studio Code embedded software development workflow**: USB device management and embedded debug can be adapted to other project formats (for example CMake) and toolchains without additional overhead. This use case requires familiarity with Visual Studio Code to configure tasks. See the individual extensions for more details.
 
 ## Extensions available in the pack
 
@@ -36,15 +42,9 @@ The pack also installs:
 
 - **Microsoft C/C++ Themes** (Identifier: `ms-vscode.cpptools-themes`): This extension works in combination with **Microsoft C/C++** to provide syntax highlighting.
 
-## Intended use cases for the extensions
-
-- **Embedded and IoT software development using CMSIS-Packs and csolution projects**: The "Common Microcontroller Software Interface Standard" (CMSIS) provides driver, peripheral and middleware support for thousands of MCUs and hundreds of development boards. Using the csolution project format, you can incorporate any CMSIS-Pack based device, board, and software component into your application. For more information about supported hardware for CMSIS projects, go to the [Boards](https://www.keil.arm.com/boards/) and [Devices](https://www.keil.arm.com/devices/) pages on keil.arm.com. For information about CMSIS-Packs, go to [open-cmsis-pack.org](https://www.open-cmsis-pack.org/index.html).
-
-- **Enhancement of a pre-existing Visual Studio Code embedded software development workflow**: USB device management and embedded debug can be adapted to other project formats (for example CMake) and toolchains without additional overhead. This use case requires familiarity with Visual Studio Code to configure tasks. See the individual extensions for more details.
-
 ## Install the extensions
 
-1. In Visual Studio Code desktop, go to the **Extensions** view.
+1. In Visual Studio Code Desktop, go to the **Extensions** view.
 
 1. Search for **Keil Studio Pack**.
 
@@ -57,6 +57,30 @@ The pack also installs:
 
 1. Click **Activate**.
 
+## Keil Studio Pack pre-release
+
+The extensions only available in the pre-release are:
+
+- **Arm Debugger** (Identifier: `arm.arm-debugger`): This extension provides access to the Arm Debugger engine for Visual Studio Code by implementing the Microsoft Debug Adapter Protocol (DAP). Arm Debugger supports connections to physical targets, either through external debug probes such as the Arm's ULINK™ family of debug probes, or through on-board low-cost debugging such as ST-Link or CMSIS-DAP based debug probes.
+
+- **Memory Inspector** (Identifier: `eclipse-cdt.memory-inspector`): This extension allows you to analyze and monitor the memory contents in an embedded system. It helps you to identfiy and debug memory-related issues during the development phase of your project.
+
+- **Peripheral Inspector** (Identifier: `eclipse-cdt.peripheral-inspector`): This extension uses System View Description (SVD)<!--Can we say CMSIS-SVD here?--> files to display peripheral details. SVD files <!--CMSIS-SVD?-->provide a standardized way to describe the memory-mapped registers and peripherals of a microcontroller or a System-on-Chip (SoC).
+
+To install the pre-release:
+
+1. In Visual Studio Code Desktop, go to the **Extensions** view.
+
+1. Search for **Keil Studio Pack** and select it in the list of available extensions. 
+
+    - If you did not have the official pack already installed, click the arrow next to the **Install** button and select **Install Pre-Release Version**.
+
+    ![Install pre-release version](./docs/images/install-pre-release.png)
+
+    - If you have the official pack already installed, click the **Switch to Pre-Release Version** button on the welcome page that displays when you select the pack from the list.
+
+    ![Switch to pre-release version](./docs/images/install-pre-release-02.png)
+
 ## Submit feedback
 
 To submit feedback, please [see our support page](https://www.keil.arm.com/support/#:~:text=Keil%20Studio%20for%20VS%20Code).