Skip to content

Commit

Permalink
Polish Walkthrough v2
Browse files Browse the repository at this point in the history
  • Loading branch information
radurentea committed Nov 22, 2024
1 parent 0582ad4 commit 3e486c5
Show file tree
Hide file tree
Showing 14 changed files with 15 additions and 15 deletions.
Binary file modified media/walkthrough/examples-list.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 modified media/walkthrough/icons/build-flash-monitor.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 modified media/walkthrough/icons/build.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 modified media/walkthrough/icons/debug.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 modified media/walkthrough/icons/device-target.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 modified media/walkthrough/icons/flash-method.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 modified media/walkthrough/icons/flash.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 modified media/walkthrough/icons/monitor.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 modified media/walkthrough/icons/port.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 modified media/walkthrough/icons/sdkconfig.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/checkExtensionSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export async function checkExtensionSettings(
try {
const isExtensionConfigured = await isCurrentInstallValid(workspace);
if (isExtensionConfigured) {
vscode.commands.executeCommand("espIdf.welcome.start");
await vscode.commands.executeCommand("espIdf.welcome.start");
return;
}
} catch (error) {
Expand Down
3 changes: 1 addition & 2 deletions walkthroughs/advanced/sdk-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
## Opening SDK Configuration
![Menuconfig Interface](../../media/walkthrough/gifs/menuconfig.gif)

1. Click the menuconfig icon in status bar
- Or use Command Palette: "ESP-IDF: SDK Configuration Editor"
1. Click the "SDK Configuration editor" icon from the status bar !["SDK Configuration editor"](../../media/walkthrough/icons/sdkconfig.png) or use the "ESP-IDF: SDK Configuration Editor(Menuconfig)" command

## Troubleshooting

Expand Down
8 changes: 4 additions & 4 deletions walkthroughs/basic/build-flash-monitor.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Building, Flashing, and Monitoring Your ESP-IDF Project

### Building Your Project
Click the "Build Project" icon from the status barn !["Build Project"](../../media/walkthrough/icons/build.png) or use command `ESP-IDF: Build your Project`
- Click the "Build Project" icon from the status bar !["Build Project"](../../media/walkthrough/icons/build.png) or use the `ESP-IDF: Build your Project` command

### Flashing to Device
Before flashing, make sure your device is connected and you've selected the correct port
Click "Flash Device" icon from the status bar !["Flash Device"](../../media/walkthrough/icons/flash.png) or use the command `ESP-IDF: Flash (UART) your Project`
- Click "Flash Device" icon from the status bar !["Flash Device"](../../media/walkthrough/icons/flash.png) or use the `ESP-IDF: Flash your Project` command

### Monitoring Output
Click "Monitor Device" icon from the status bar !["Monitor Device"](../../media/walkthrough/icons/monitor.png) or use the command `ESP-IDF: Monitor Device`
- Click "Monitor Device" icon from the status bar !["Monitor Device"](../../media/walkthrough/icons/monitor.png) or use the `ESP-IDF: Monitor Device` command

### All-in-One Operation

The most convenient way is using "Build, Flash and Monitor":
* Click the "Build, Flash and Monitor" icon from the status bar !["Build, Flash and Monitor"](../../media/walkthrough/icons/build-flash-monitor.png) or use the command `ESP-IDF: Build, Flash and Start a Monitor on your Device`
* Click the "Build, Flash and Monitor" icon from the status bar !["Build, Flash and Monitor"](../../media/walkthrough/icons/build-flash-monitor.png) or use the `ESP-IDF: Build, Flash and Start a Monitor on your Device` command

### Common Issues

Expand Down
17 changes: 9 additions & 8 deletions walkthroughs/basic/setup-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@

### 2. Configure Project Settings (not needed in our example)

1. Open ESP-IDF Configuration editor (menuconfig):
- Use the "ESP-IDF: SDK Configuration Editor(Menuconfig)" command
- Or click the "SDK Configuration editor" icon from the status bar !["SDK Configuration editor"](../../media/walkthrough/icons/sdkconfig.png)
1. Click the "SDK Configuration editor" icon from the status bar !["SDK Configuration editor"](../../media/walkthrough/icons/sdkconfig.png) or use the "ESP-IDF: SDK Configuration Editor(Menuconfig)" command


> 💡 **Tip**: For a comprehensive list of available configuration options, check the [ESP-IDF Configuration Options Reference](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig.html#configuration-options-reference)
Expand All @@ -21,17 +19,20 @@
1. Connect your ESP device to your computer
2. Select the correct serial port:
- Click the "Select Port to Use" icon from VS Code's status bar
!["Select Port to Use"](../../media/walkthrough/icons/port.png)

- Or use "ESP-IDF: Select Port to Use" command
!["Select Port to Use"](../../media/walkthrough/icons/port.png) or use "ESP-IDF: Select Port to Use" command

### 4. Set Flashing Method (UART recommended for simplicity)

- Use the "ESP-IDF: Select Flash Method" command
- Or click the "Select Flash Method" icon from the status bar !["Select Flash Method"](../../media/walkthrough/icons/flash-method.png)
1. Click the "Select Flash Method" icon from the status bar !["Select Flash Method"](../../media/walkthrough/icons/flash-method.png) or use the "ESP-IDF: Select Flash Method" command

## Related Resources

For more in depth information about connecting your device and setting up the project, check out our documentation:
- [Connect Your Device](https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/connectdevice.html)
- [Configure Your Project](https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/configureproject.html)

<script>
window.onload = function() {
window.scrollTo(0, 0);
}
</script>

0 comments on commit 3e486c5

Please sign in to comment.