Skip to content

Conversation

@olegznv
Copy link
Contributor

@olegznv olegznv commented Mar 5, 2025

Description

This article is a tutorial about how to work with an ESP-IDF project in CLion, a cross-platform C and C++ IDE. The tutorial explains how to build an application, flash it to an ESP32-S3 board, debug it, and more.

Related

Testing


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow f-hollow merged commit 5634352 into espressif:main Mar 13, 2025
3 of 4 checks passed
Copy link
Collaborator

@f-hollow f-hollow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olegznv Sorry for my belated review!

I merged the article because I know it should be online faster. It looks good!

If you have a chance, you can do a couple of things in a follow-up PR:

  • Please check my only comment about mini USB.
  • Feel free to update the article date.

Another general comment: I am not sure what your JetBrains style guide says, but we tend to pay attention to list hierarchies. You have numbered lists mixed with bullet lists at the same indentation level. I guess the bullet lists should be sublists to the numbered lists to highlight the underlying hierarchy and, eventually, provide better orientation to the readers. Likewise, the screenshots should be indented accordingly.

So if you have a chance, please submit a follow-up PR. Thank you!


- ESP32-S3-DevKitC-1 v1.1.
- MacBook Pro M2 Max.
- USB-C to mini USB cable.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ESP boards always have micro USB ports. Also, please mention that it should be a data cable, because you can accidentally run into a cable for charging only.

Suggested change
- USB-C to mini USB cable.
- USB-C to micro USB data cable.

@f-hollow
Copy link
Collaborator

f-hollow commented Mar 13, 2025

@olegznv I also noticed that you don't appear as an author. I know it is a bit counterintuitive with Hugo.

As documented in the Contribution guide, you still need to create the file data/authors/<author-name>.json and populate your information there. For examples, please refer to other files in that folder.

@olegznv
Copy link
Contributor Author

olegznv commented Mar 13, 2025

@f-hollow thank you! Sorry for these mistakes and inaccuracies. I'll fix them in a follow-up PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants