New Project Wizard - nxp-mcuxpresso/vscode-for-mcux GitHub Wiki

Introduction

New Project Wizard can be used to generate a minimal project from scratch. The Wizard can be found in the Quickstart Panel.

New Project Wizard supports projects based either on MCUXpresso SDK or Zephyr.

Generated projects will be based on the new_project template wherever possible, but will fallback to hello_world and blinky if any of the past templates are not available for the board.

Searching and filtering

Upon opening the New Project Wizard, all of the possible boards that can be used will be displayed in the middle of the view. In order to narrow down the selection, searching and filtering is available.

The search will try to match boards with the identifier or name provided in the query. However, it is also possible to search for other board related data in the query. Partial matching is also supported.

It is also possible to further narrow the results by filtering. Boards can be filtered by project type (MCUXpresso or Zephyr) and the various features that they support. The filter conditions are applied with an OR operator, therefore results that match at least one property will be fetched.

The view can also be converted from a grid view to a list view, that contains more information, such as RAM and Flash.

Project generation

Upon selecting a board, the wizard will expand to allow the user to select a repository, a build toolchain, a project name and a location.

The repository can either be a new repository that will be cloned specifically for this new project, or an already existing one.

Note: Importing a new repository for the project will also import the repository into the list of available repositories, except in the case of Zephyr. New Project Wizard will clone a minimal Zephyr repository that can only be used for that project.

There is also the option to open the configuration tools specific for the project type, after import. In the case of MCUXpresso SDK, Configuration Tools will be opened, as opposed to GUIConfig for Zephyr (kernel configuration, KConfig).

After pressing "Create Project", the project will start generating at the specified location. A notification will show the progress of the operation.

In some cases, specifically for MCUXpresso project, a new project may have multiple variants (some examples may be variants of the same template, but for different cores of the target). Since the Wizard cannot determine which sample should be used, it will prompt a selection in a quick pick.