search

espressif / idf-eclipse-plugin

Espressif-IDE (based on Eclipse CDT) for ESP-IDF CMake based projects 4.x and above
Eclipse Public License 2.0
302 stars 121 forks source link

IEP-1064 Improvements around debugging Documentation #894

Closed sigmaaa closed 7 months ago

sigmaaa commented 8 months ago

Description

the main details about debugging separated from the debug documentation to the main readme

Fixes # (IEP-1064)

Type of change

Please delete options that are not relevant.

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test Configuration:

Dependent components impacted by this PR:

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The README.md file for the ESP-IDF Eclipse plugin has been enhanced with additional guidance for Windows users, including instructions on installing drivers using Zadig for successful debugging sessions. These updates aim to improve the debugging experience and address potential issues specific to Windows environments.

Changes

File Change Summary
README.md Updated the guide with instructions for installing drivers using Zadig on Windows for successful debugging sessions. Added a note highlighting this step and improved the clarity of the debug setup process.

Related issues

🐰🔧
In the Windows realm where drivers may confide,
Zadig comes forth, with debugging as our guide.
Errors vanish, like shadows in the light,
Windows debugging now a smoother flight.
🌌🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
AndriiFilippov commented 8 months ago

@sigmaaa hi !

In general, looks nice ! I think animations is what our documentation is really NEED 👍

In my opinion, since 90% of our users are using Windows, I would duplicate the information about Zadig tool in the Debug section. Currently, this information about Zadig is in the DFU section, but few people use it, so there is a high probability that the user is unlikely to see it. Debugging on Windows is impossible without it.

image

sigmaaa commented 8 months ago

Hi @AndriiFilippov, thank you for review. I added a new note which mentions driver installation via a link in the last commit

kolipakakondal commented 8 months ago

Hi @sigmaaa Can you also use the icons from here for referrring debug icons and others.

For example, I have used launch icon here

sigmaaa commented 8 months ago

Hi @sigmaaa Can you also use the icons from here for referrring debug icons and others.

For example, I have used launch icon here

Hi @kolipakakondal, thank you for review. I added an icon in the latest commit

kolipakakondal commented 8 months ago

Note: If you're using Windows, you may need to install drivers using Zadig to run a debug session successfully. For detailed instructions, please refer to this guide.

Here can we add a direct link for driver installation instructions . This is having detailed platform specific instructions.

sigmaaa commented 8 months ago

updated guide URL to the espressif zadig doc