diff --git a/docs/create_app.md b/docs/create_app.md index 8d1fea3..7e9d6df 100644 --- a/docs/create_app.md +++ b/docs/create_app.md @@ -147,7 +147,7 @@ The following files are created for the solution: !!! CAUTION If you see this warning: ![Task errors output](./images/task-errors.png) - Click **Show output** to configure the solution. You can add board, shield, or socket layers to your reference + Click **Show output** to¬ configure the solution. You can add board, shield, or socket layers to your reference application. You can also select a compiler for reference applications and other solution types. Depending on the selected example, you might need to [configure the solution](./configuration.md#configure-a-solution) @@ -207,29 +207,24 @@ For all solution types, the compiler is added with the `compiler:` key in the `c - The CMSIS-Packs which contain reference applications and layers generally provide an `Overview.md` file where the connections are detailed. -## Software components +## Software components and packs A [software component](https://open-cmsis-pack.github.io/cmsis-toolbox/CreateApplications/#software-components) -encapsulates a set of related functions. The **Software Components** view shows all the software components selected in -the active project of a solution. - -You can: - -- Modify the software components of the project. - -- Manage the dependencies between components for each target type defined in your solution, or for all the target types at - once. +encapsulates a set of related functions and is delivered in a +[software pack](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). The +**Software Components** view enables you to manage the software components and software packs selected in the active +project of a solution. ### Software Components view Open the **CMSIS view** and click ![Manage software components](./images/software-components-icon.png) to open the **Software Components** view: -![The 'Software Components' ](./images/software-components-view.png) +![The 'Software Components' view](./images/software-components-view.png) You can: -1. Switch between *components* and *software packs*. +1. Switch between *components* and [*software packs*](#software-packs). 2. View only components that are *part of the csolution* or components from *all installed packs*. 3. Set the *context* for which the component selection applies (including layers). 4. *Select/remove* software components. @@ -284,7 +279,7 @@ If there are validation issues: When done, don't forget to **Save** the changes! -### RTOS Example +### RTOS example This example shows how to add a real-time operating systems (RTOS), such as Keil RTX5. @@ -317,3 +312,38 @@ project: # CMSIS-Pack containing the RTOS component added: - pack: ARM::CMSIS-RTX ``` + +### Software packs + +![The 'Software Components - Software packs' view](./images/software-packs.png) + +You can: + +1. Switch between [*components*](#software-components-view) and *software packs*. +2. View only software packs that are *part of the csolution* or view *all installed packs*. +3. Select the scope for which the software pack selection applies (solution/project/layer). +4. Examine on which level the packs are references (csolution/cproject/clayer). +5. [*Manage software packs*](#manage-software-packs). +6. Open *related documentation*. + +#### Manage software packs + +Click on either icon: ![Manage software packs](./images/manage-packs.png) to open the **Manage Pack** dialog: + +![Manage Pack dialog](./images/manage-pack-dialog.png) + +In the **Current References** section, you can: + +- Set the specific + [version](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_package_pg.html#VersionType) for a + pack to be used on the csolution/cproject/clayer level. Use these version specifiers: + - `Unspecified`: use the latest installed version of a pack + - `@`: exact version + - `@>=`: equal or higher + - `@^`: equal or higher with same major version + - `@~`: Equal or higher with same major *and* minor version +- Add a pack to a csolution/cproject/clayer. + +Below that, the *used pack* version is shown. It is computed from the requirements above. + +In the **Update Pack** section, you can see the latest installed version and check for updates. diff --git a/docs/featureroadmap.md b/docs/featureroadmap.md index 9fd2a0b..d3d833a 100644 --- a/docs/featureroadmap.md +++ b/docs/featureroadmap.md @@ -4,19 +4,19 @@ ### Project creation and organization -| Feature | Description | -| ------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| 🟢 [Project creation](./create_app.md) | Create, open, and manage CMSIS solution projects | -| 🟢 [Multi-project solution](./create_app.md) | Manage multiple related projects within a single CMSIS solution | -| 🟢 Multi-solution workspace | Manage multiple solutions within one workspace (Timeline: VS Code built-in) | -| 🟢 [Target types](./manage_settings.md) | Multiple targets (e.g., HW, models) within one solution | -| 🟢 [Build types](./manage_settings.md) | Multiple build types (e.g., Debug, Release) within one solution | -| 🟢 [File groups](./userinterface.md#cmsis-view) | Logical grouping of source, header, and library files | -| 🟢 [Layer support](./create_app.md#configuration) | Easily retarget hardware connections | -| 🟢 [Software components](./create_app.md#software-components) | Manage software components on a project/layer level | -| 🟡 Manage packs | Manage CMSIS-Packs and versions graphically | -| 🟢 [Zephyr project support](./zephyr.md) | Build and debug Zephyr-based applications | -| 🟢 [Configuration Wizard](./userinterface.md#configuration-wizard) | GUI-assisted generation and modification of configuration code | +| Feature | Description | +| ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | +| 🟢 [Project creation](./create_app.md) | Create, open, and manage CMSIS solution projects | +| 🟢 [Multi-project solution](./create_app.md) | Manage multiple related projects within a single CMSIS solution | +| 🟢 Multi-solution workspace | Manage multiple solutions within one workspace (VS Code built-in) | +| 🟢 [Target types](./manage_settings.md) | Multiple targets (e.g., HW, models) within one solution | +| 🟢 [Build types](./manage_settings.md) | Multiple build types (e.g., Debug, Release) within one solution | +| 🟢 [File groups](./userinterface.md#cmsis-view) | Logical grouping of source, header, and library files | +| 🟢 [Layer support](./create_app.md#configuration) | Easily retarget hardware connections | +| 🟢 [Software components](./create_app.md#software-components-and-packs) | Manage software components on a project/layer level | +| 🟡 Manage packs | Manage CMSIS-Packs and versions graphically | +| 🟢 [Zephyr project support](./zephyr.md) | Build and debug Zephyr-based applications | +| 🟢 [Configuration Wizard](./userinterface.md#configuration-wizard) | GUI-assisted generation and modification of configuration code | ### Build system @@ -37,12 +37,12 @@ ### Integration and extensibility -| Feature | Description | -| -------------------------------------------- | ----------------------------------------------------------------------------- | -| 🟢 [External tools](./runexternal.md) | Invoke third-party tools via configurable commands | -| 🟢 Version control | Excellent integration with Git (Timeline: VS Code built-in) | -| 🟢 AI coding agents | Integration with third-party coding agents (Timeline: via VS Code extensions) | -| 🟢 Additional extensions | Use third-party extensions with Keil Studio (Timeline: VS Code built-in) | +| Feature | Description | +| -------------------------------------------- | ------------------------------------------------------------------- | +| 🟢 [External tools](./runexternal.md) | Invoke third-party tools via configurable commands | +| 🟢 Version control | Excellent integration with Git (VS Code built-in) | +| 🟢 AI coding agents | Integration with third-party coding agents (via VS Code extensions) | +| 🟢 Additional extensions | Use third-party extensions with Keil Studio (VS Code built-in) | ## Compiler support @@ -130,7 +130,7 @@ | 🔴 Performance analysis | Execution time analysis | | 🔴 Performance analysis | Function profiling | | 🔴 Execution statistics | Code coverage | -| 🟡 Execution statistics | Timing statistics (Timeline: only via Event Recorder) | +| 🟡 Execution statistics | Timing statistics (only via Event Recorder) | ### Simulation diff --git a/docs/images/manage-pack-dialog.png b/docs/images/manage-pack-dialog.png new file mode 100644 index 0000000..a395f17 Binary files /dev/null and b/docs/images/manage-pack-dialog.png differ diff --git a/docs/images/manage-packs.png b/docs/images/manage-packs.png new file mode 100644 index 0000000..55291c0 Binary files /dev/null and b/docs/images/manage-packs.png differ diff --git a/docs/images/software-packs.png b/docs/images/software-packs.png new file mode 100644 index 0000000..92a823e Binary files /dev/null and b/docs/images/software-packs.png differ diff --git a/docs/index.md b/docs/index.md index 7b42bab..a66bec5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,6 +46,7 @@ The IDE: Version | Description :------------------|:------------------------- +1.66.0 | Added **Software pack**, **Related Documentation**, and **Features and roadmap** chapters 1.64.0 | Added **Work with Zephyr applications** and reworked other chapters 1.62.0 | Reworked **Manage solutions** and **Debug** chapters 1.55.0 | Rework for better clarity diff --git a/docs/userinterface.md b/docs/userinterface.md index 4d80f96..ba0b27b 100644 --- a/docs/userinterface.md +++ b/docs/userinterface.md @@ -158,7 +158,7 @@ You can access commands to manage your solution and the related projects in the | Close Solution | Close the current active solution. | | [Manage Solution Settings](./manage_settings.md) | Configure the target set (active target, projects, images, and debug adapter) for the solution. | | [Configure Solution](./create_app.md#configure-a-solution) | Set a compiler and add software layers. | -| [Manage Software Components](./create_app.md#software-components) | Review, add, or remove software components. | +| [Manage Software Components](./create_app.md#software-components-and-packs) | Review, add, or remove software components. | | [Build solution](./build_run.md) | Build the solution with the current target set. | | Rebuild solution | Rebuild the solution with the current target set. | | Clean all out and tmp directories | Clean all out and tmp directories for the active solution. | diff --git a/mkdocs.yml b/mkdocs.yml index cda0b24..016e88f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Arm Keil Studio for VS Code extra: - version: 1.64.0 + version: 1.66.0 repo_name: GitHub repo_url: https://github.com/MDK-Packs/vscode-cmsis-solution-docs edit_uri: edit/main/docs/