Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[VSC-1258] feature/walkthrough #1298

Merged
merged 18 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
wip: finish create project step
Restyle markdowns
  • Loading branch information
radurentea committed Nov 19, 2024
commit dc6b4d895d54b83af6ab2a29557d76d45148ce62
Binary file added media/walkthrough/create-project.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 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.
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,7 @@
"title": "Creating an Example Project",
"description": "Now, let's create a new project from ESP-IDF examples:\n\n[Show Example Projects](command:espIdf.examples.start)\n\nAlternatively, you can open the Command Palette and type 'ESP-IDF: Show Examples Projects'.\n\n💡 Explore different examples to find one that suits your needs.",
"media": {
"image": "media/walkthrough/create-example.png",
"altText": "GIF of creating an example project"
"markdown": "walkthroughs/create-example.md"
}
},
{
Expand Down
12 changes: 6 additions & 6 deletions walkthroughs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Configure the ESP-IDF VS Code Extension

## 1. Install Prerequisites (macOS and Linux only)
### 1. Install Prerequisites (macOS and Linux only)
Follow the steps in our [ESP-IDF installation documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#step-1-install-prerequisites) for a quick and simple process.

## 2. Select Setup Mode
### 2. Select Setup Mode
Choose the Express setup mode (recommended).
![Express Setup Mode selection](../media/walkthrough/express-setup.png)

## 3. Choose ESP-IDF Version
### 3. Choose ESP-IDF Version
Expend dropdown menu and select an ESP-IDF version.

![ESP-IDF Version selection](../media/walkthrough/idf-version.png)

## 4. Set Python Path (macOS and Linux only)
### 4. Set Python Path (macOS and Linux only)
Choose the appropriate Python path from the dropdown.

![Python Path selection](../media/walkthrough/python-selection.png)

## 5. Install
### 5. Install
Click the Install button to begin the installation process.

![Start Installation](../media/walkthrough/install-btn.png)

## 6. Post-Installation Step (Linux only)
### 6. Post-Installation Step (Linux only)
After installation, run the following command in your preferred terminal:
```
sudo cp --update=none /home/hmp/.espressif/tools/openocd-esp32/v0.12.0-esp32-20240318/openocd-esp32/share/openocd/contrib/60-openocd.rules /etc/udev/rules.d
Expand Down
21 changes: 21 additions & 0 deletions walkthroughs/create-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Create a Project Using an ESP-IDF Example

### 1. Select an Example Project
Choose an example project from the list provided. For beginners, we recommend starting with the Blink example.

![Example project selection](../media/walkthrough/examples-list.png)

### 2. Create the Project
Click the "Create project using example blink" button to proceed.

![Create project button](../media/walkthrough/create-project.png)

After clicking the button, you'll be prompted to choose a location where the project will be created.

## Next Steps

Once you've created your project:
- Explore the project structure in VS Code
- Review the example code to understand its functionality
- Build and flash the project to your ESP device
- Modify the code to experiment and learn