Skip to content

Commit

Permalink
Added walkthroughs (appear on the Getting Started page) to introduce …
Browse files Browse the repository at this point in the history
…users to features of the PlatformIO ecosystem
  • Loading branch information
ivankravets committed Dec 11, 2022
1 parent e5f05fd commit 03dde30
Show file tree
Hide file tree
Showing 7 changed files with 98 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Binary file added assets/welcome/platformio-core-cli-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/welcome/platformio-ide-view-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions assets/welcome/platformio-ini-example.md
Original file line number Diff line number Diff line change
@@ -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
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/welcome/project-inspection-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 65 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 03dde30

Please sign in to comment.