diff --git a/CHANGELOG.md b/CHANGELOG.md index a6b7d5f..1b54739 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,8 @@ * Show project configuring progress * Log configuration process to the output channel * Added support for canceling project configuration process -- UI Improvements +- UX/UI Improvements + * Added walkthroughs (appear on the Getting Started page) to introduce users to features of the PlatformIO ecosystem * Added support for the macOS Touch Bar (issue [#311](https://github.com/platformio/platformio-vscode-ide/issues/311)) * Added "Build/Upload/Test/Clean" and "Serial Monitor" buttons to the Editor title bar * Added PlatformIO commands to the Explorer context menu: diff --git a/assets/welcome/platformio-core-cli-demo.png b/assets/welcome/platformio-core-cli-demo.png new file mode 100644 index 0000000..ca39eb0 Binary files /dev/null and b/assets/welcome/platformio-core-cli-demo.png differ diff --git a/assets/welcome/platformio-ide-view-demo.png b/assets/welcome/platformio-ide-view-demo.png new file mode 100644 index 0000000..cf29689 Binary files /dev/null and b/assets/welcome/platformio-ide-view-demo.png differ diff --git a/assets/welcome/platformio-ini-example.md b/assets/welcome/platformio-ini-example.md new file mode 100644 index 0000000..b811bfd --- /dev/null +++ b/assets/welcome/platformio-ini-example.md @@ -0,0 +1,31 @@ +```ini +; Common configuration +[env] +platform = espressif32@^5 +framework = arduino +board = esp32doit-devkit-v1 +monitor_speed = 921600 +monitor_filter = esp32_exception_decoder +lib_deps = + nanopb/Nanopb @ ^0.4.6 + infineon/TLV493D-Magnetic-Sensor @ ^1.0.3 +build_flags = + -D ARDUINO_LOOP_STACK_SIZE=2048 + -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG + -Wno-nonnull-compare + +; Production environment +[env:release] +build_flags = + ${env.build_flags} + -D PRODUCTION=1 + +; Development environment +[env:develop] +build_type = debug +lib_deps = + ${env.lib_deps} + bakercp/PacketSerial @ 1.4.0 +debug_extra_cmds = + set remote hardware-watchpoint-limit 2 +``` diff --git a/assets/welcome/platformio-package-registry-demo.png b/assets/welcome/platformio-package-registry-demo.png new file mode 100644 index 0000000..37ee269 Binary files /dev/null and b/assets/welcome/platformio-package-registry-demo.png differ diff --git a/assets/welcome/project-inspection-demo.png b/assets/welcome/project-inspection-demo.png new file mode 100644 index 0000000..3908650 Binary files /dev/null and b/assets/welcome/project-inspection-demo.png differ diff --git a/package.json b/package.json index dc4582e..61b8f1c 100644 --- a/package.json +++ b/package.json @@ -593,6 +593,71 @@ "contents": "Initializing PlatformIO Core..." } ], + "walkthroughs": [ + { + "id": "platformio-ide.welcome", + "title": "Get started with PlatformIO IDE", + "description": "The most loved IDE solution for Microsoft Visual Studio Code", + "steps": [ + { + "id": "platformio-core", + "title": "Rich CLI developed for Humans", + "description": "[PlatformIO Core](https://bit.ly/vscode-platformio-core-docs) is the heart of PlatformIO IDE and it's your one-stop shop for professional embedded development.\nIt takes care of everything from dependency management to testing, so you can focus on what matters most โ€“ your project.\n[Install PlatformIO Core](command:platformio-ide.openPIOCoreCLI)", + "media": { + "image": "assets/welcome/platformio-core-cli-demo.png", + "altText": "PlatformIO Core CLI Demo" + }, + "completionEvents": [ + "onContext:pioCoreReady" + ] + }, + { + "id": "platformio.ini", + "title": "Platform-agnostic shareable configuration", + "description": "[platformio.ini](https://bit.ly/vscode-platformio-ini-docs) is the single configuration file that lets you set up your development environment and share your configurations with your team or organization.\nLeverage a declarative approach to embedded development and the power of semantic versioning.\n[Learn More](https://bit.ly/vscode-platformio-ini-docs)", + "media": { + "markdown": "assets/welcome/platformio-ini-example.md" + }, + "completionEvents": [ + "onLink:https://bit.ly/vscode-platformio-ini-docs" + ] + }, + { + "id": "platformio-home", + "title": "Advanced project management", + "description": "Boost your product development with [PIO Home](https://bit.ly/vscode-platformio-home-docs) โ€“ a powerful, modern, and interactive user interface for advanced project management.\nIt allows you to enhance your project source code with advanced instruments such as firmware explorer, memory inspection, and static code analysis.\n[Open PIO Home](command:platformio-ide.showHome)\nTip: Use ๐Ÿ  icon at the bottom status bar.", + "media": { + "image": "assets/welcome/project-inspection-demo.png", + "altText": "PlatformIO Project Inspection Demo" + } + }, + { + "id": "explore-more-resources", + "title": "Explore more resources", + "description": "๐Ÿ“ฆ Browse over 10,000 libraries from software vendors, open-source projects, and the community in the [PlatformIO Registry](https://bit.ly/platformio-registry).\n๐Ÿš€ Learn more about getting started with [PlatformIO IDE for VSCode](https://bit.ly/platformio-ide-for-vscode-docs).\n๐Ÿงก Have any ideas or need help with your project? Ask our awesome [PlatformIO Community](https://community.platformio.org/).\n[Learn More](https://bit.ly/platformio-ide-for-vscode-docs)", + "media": { + "image": "assets/welcome/platformio-package-registry-demo.png", + "altText": "PlatformIO Package Registry" + }, + "completionEvents": [ + "onLink:https://bit.ly/platformio-ide-for-vscode-docs" + ] + }, + { + "id": "ready-to-start", + "title": "Ready to start?", + "description": "Navigate to the PlatformIO IDE View in the left activity bar and open an existing project or create a new one.\n[Open PlatformIO IDE View](command:workbench.view.extension.platformio)", + "media": { + "image": "assets/welcome/platformio-ide-view-demo.png", + "altText": "PlatformIO IDE View" + }, + "completionEvents": [ + "onView:platformio-ide.projectTasks" + ] + } + ] + } + ], "keybindings": [ { "command": "platformio-ide.build",