docs: Update the README_CN file #1067
Conversation
WalkthroughThe changes in this pull request involve updates to the Changes
Possibly related PRs
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (20)
README_CN.md (14)
Line range hint
5-18: LGTM! Title and introduction improvements enhance clarity.The updated title, rephrased introduction, and simplified project support note improve the overall clarity and focus of the document. These changes effectively highlight the key features and make the content more accessible to users.
Consider adding a link to the ESP-IDF documentation for more detailed information about supported projects. This could be helpful for users who need specific details about project compatibility.
68-92: Great update to the installation instructions!The revised installation section provides clear, OS-specific guidance and emphasizes the use of Espressif-IDE. The prerequisites are well-defined, helping users prepare for a smooth installation process.
To further improve clarity, consider adding a brief explanation of why Espressif-IDE is recommended over the Eclipse CDT + IEP plugin update method. This could help users understand the benefits of the recommended approach.
🧰 Tools
🪛 Markdownlint
80-80: null
Bare URL used(MD034, no-bare-urls)
117-152: Comprehensive ESP-IDF installation and management instructions!The detailed process for installing ESP-IDF within Espressif-IDE and managing multiple versions is well-explained. This feature provides great flexibility for developers working with different ESP-IDF versions.
Consider adding a brief note about best practices for managing multiple ESP-IDF versions, such as when to use different versions and how to ensure project compatibility. This could help users make informed decisions when working with multiple versions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~130-~130: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：适当"地"可
Context: ...统路径中，则将预加载到以上界面中；如果没有，请点击浏览，在文件夹中选择适当的可执行文件。 3. 点击完成。该按钮将在所有路径和可执行文件得到正确配置...(wb4)
[uncategorized] ~148-~148: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...DF_Manager_Multiple_versions.png) 若想激活某一版本，请点击激活列中对应的单选按钮。 编辑器中中最后一列的刷新按钮可用于重...(wa5)
🪛 Markdownlint
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
155-194: Clear instructions for project creation and configuration!The step-by-step guide for creating a new project, configuring the build target, and building the project is well-structured and easy to follow. The inclusion of screenshots enhances the clarity of the instructions.
To further assist users, consider adding a troubleshooting tip or common pitfalls section for the build process. This could help users quickly resolve any issues they might encounter during these steps.
🧰 Tools
🪛 Markdownlint
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
199-232: Well-explained flashing and serial output monitoring process!The instructions for flashing the project and viewing serial output are clear and easy to follow. The inclusion of information about customizing flash parameters is helpful for advanced users. The screenshots effectively illustrate the process.
Consider adding a brief explanation of common serial output messages or patterns that users might see, particularly those related to successful flashing or common errors. This could help users interpret the output more effectively.
🧰 Tools
🪛 Markdownlint
226-226: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
235-249: Simplified debugging setup instructions are helpful!The two-step process for setting up debugging is clear and easy to follow. The inclusion of Windows-specific driver information is valuable for users on that platform.
To make the debugging section more comprehensive, consider the following additions:
- Provide a brief overview of what users can do once the debugger is running (e.g., setting breakpoints, stepping through code, inspecting variables).
- Add a short troubleshooting section for common debugging issues.
- Include a link to more detailed debugging documentation for users who need advanced features.
These additions would give users a better understanding of the debugging capabilities and help them make the most of this feature.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"启动
Context: ...sb-drivers)。 创建调试配置的最快方式是展开启动栏中的配置列表并点击新的启动配置...。然后选择ESP-IDF GDB OpenOCD 调试-...(wb4)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"调试
Context: ...DF GDB OpenOCD 调试-> 双击或点击下一步`。接下来会打开新的调试配置预览页面，请仔细检查开发板的设置。 创建调试配置后就可以开始调试项目了...(wb4)
🪛 Markdownlint
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
273-282: Clear instructions for using the SDK Configuration Editor!The steps for accessing and using the SDK Configuration Editor are well-explained, including how to save changes and revert modifications.
To enhance this section, consider adding the following:
- A brief explanation of what the SDK Configuration Editor is and its importance in ESP-IDF development.
- Examples of common configurations that users might want to modify.
- A note about how changes in the SDK Configuration Editor can affect the project build and behavior.
These additions would provide users with more context and help them understand when and why they might need to use this tool.
🧰 Tools
🪛 Markdownlint
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
286-293: Good introduction to the CMake Editor feature!The section effectively introduces the CMake Editor and its key capabilities, such as syntax highlighting and code templates. The instructions for configuring the editor are helpful.
To make this section more valuable for users, consider adding:
- A brief explanation of why CMake is important in ESP-IDF projects and how the CMake Editor can improve the development workflow.
- One or two practical examples of common CMake tasks that users might perform (e.g., adding source files, configuring build flags).
- Tips for effectively using the code templates and command assistant features.
These additions would help users understand the practical benefits of the CMake Editor and encourage them to make the most of this feature.
🧰 Tools
🪛 Markdownlint
289-289: null
Images should have alternate text (alt text)(MD045, no-alt-text)
293-293: null
Images should have alternate text (alt text)(MD045, no-alt-text)
296-315: Informative introduction to the ESP-IDF Application Memory Analysis feature!The section clearly introduces the Memory Analysis Editor, explains its viewing options, and provides instructions for launching the tool. The inclusion of screenshots is helpful for visual reference.
To enhance the usefulness of this section, consider adding:
- A brief explanation of why memory analysis is important in ESP-IDF development (e.g., optimizing resource usage, identifying memory leaks).
- Tips on how to interpret the results in both the Overview and Details views.
- Common scenarios where developers might need to use the Memory Analysis Editor.
- A note on how the memory analysis results can be used to improve application performance or reduce memory usage.
These additions would provide more context and practical guidance, helping users understand when and how to effectively use this tool in their development process.
🧰 Tools
🪛 Markdownlint
299-299: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
300-300: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
296-296: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
309-309: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
313-313: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
311-311: null
Images should have alternate text (alt text)(MD045, no-alt-text)
315-315: null
Images should have alternate text (alt text)(MD045, no-alt-text)
318-329: Clear introduction to the ESP-IDF Terminal feature!The section effectively introduces the ESP-IDF Terminal, explains its configuration, and provides instructions for launching it. The information about environment variables and the default working directory is valuable.
To make this section more informative, consider adding:
- A brief explanation of the advantages of using the ESP-IDF Terminal over a regular terminal (e.g., pre-configured environment, easy access to ESP-IDF tools).
- Examples of common tasks that can be performed in the ESP-IDF Terminal (e.g., running specific ESP-IDF commands, accessing tools like esptool or partition_table).
- Tips for customizing the terminal experience or adding frequently used commands.
These additions would help users understand the practical benefits of the ESP-IDF Terminal and encourage them to integrate it into their workflow more effectively.
🧰 Tools
🪛 Markdownlint
329-329: null
Images should have alternate text (alt text)(MD045, no-alt-text)
332-346: Excellent addition of the ESP-IDF Components installation feature!This new section introduces a valuable feature for easily installing ESP-IDF components directly from the IDE. The step-by-step instructions are clear, and the screenshots effectively illustrate the process.
To enhance this section and provide more value to users, consider adding:
- A brief explanation of what ESP-IDF components are and their role in ESP-IDF projects.
- Examples of common or popular components that users might want to install.
- Guidance on how to determine which components might be useful for a specific project.
- Information on how to manage or remove installed components if needed.
- A note about potential impacts of installing additional components (e.g., increased project size, new dependencies).
These additions would provide users with more context about the feature and help them make informed decisions when using it.
🧰 Tools
🪛 Markdownlint
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
348-389: Comprehensive guidance on environment variables and toolchain configuration!The sections provide valuable information on both automatic and manual configuration of environment variables and toolchains. The step-by-step instructions for manual configuration are detailed and clear.
To enhance these sections, consider the following additions:
- A brief explanation of why correct environment variable and toolchain configuration is crucial for ESP-IDF development.
- Common signs or errors that might indicate incorrect toolchain configuration.
- A troubleshooting subsection with steps to verify correct configuration and resolve common issues.
- More context around the Eclipse CDT bug, including any workarounds or expected resolution timeline if available.
These additions would help users understand the importance of proper configuration and provide guidance for resolving potential issues.
In the note about the Eclipse CDT bug (line 387), consider adding a link to a relevant issue tracker or documentation page where users can find the most up-to-date information about this bug and its status.
🧰 Tools
🪛 Markdownlint
362-362: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
378-378: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
353-353: null
Images should have alternate text (alt text)(MD045, no-alt-text)
375-375: null
Images should have alternate text (alt text)(MD045, no-alt-text)
389-389: null
Images should have alternate text (alt text)(MD045, no-alt-text)
391-402: Clear instructions for selecting the Clang toolchain!This section provides straightforward steps for selecting the Clang toolchain and includes an important note about its experimental status. The link to workarounds for common issues is a valuable addition.
To make this section more informative and useful, consider adding:
- A brief explanation of what Clang is and how it differs from the default toolchain.
- Potential benefits or use cases for choosing the Clang toolchain in ESP-IDF development.
- Any known limitations or considerations when using Clang with ESP-IDF projects.
- Guidance on how to switch back to the default toolchain if needed.
These additions would help users make an informed decision about whether to use the Clang toolchain and understand its implications for their development process.
Consider adding a note encouraging users to report any Clang-related issues they encounter, along with instructions on how to do so. This could help improve the toolchain's compatibility with ESP-IDF over time.
Line range hint
404-854: Comprehensive coverage of additional features and tools!These sections provide a wealth of information on various features, including custom launch configurations, language changing, troubleshooting, and more. The instructions are generally clear, and the inclusion of compatibility information is valuable.
To enhance the readability and usefulness of these sections, consider the following improvements:
- Add a brief introduction or summary at the beginning of this part, highlighting the most important or commonly used features.
- Use more subheadings or bullet points to break up long sections and make it easier for users to find specific information.
- Consider creating a separate "Advanced Features" section for less commonly used tools or options.
- Expand the troubleshooting section with more common issues and their solutions, possibly in a FAQ format.
- For complex features like GDBStub Debugging or Core Dump Debugging, consider adding links to more detailed documentation or tutorials.
In the compatibility table (lines 841-849), ensure that the information is up-to-date and consider adding a note about how often this information is updated.
These changes would help users navigate this information-rich section more effectively and find the specific details they need more quickly.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~533-~533: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"更新
Context: ...以按照以下步骤获取更新。 1. 前往帮助>检查更新。 2. 如有新的更新，请选择ESP-IDF Eclipse 插件，并取消勾选所有其他项目。...(wb4)
🪛 Markdownlint
638-638: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
639-639: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
508-508: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
539-539: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
510-510: null
Bare URL used(MD034, no-bare-urls)
527-527: null
Bare URL used(MD034, no-bare-urls)
587-587: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
594-594: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
467-467: null
Images should have alternate text (alt text)(MD045, no-alt-text)
475-475: null
Images should have alternate text (alt text)(MD045, no-alt-text)
489-489: null
Images should have alternate text (alt text)(MD045, no-alt-text)
505-505: null
Images should have alternate text (alt text)(MD045, no-alt-text)
518-518: null
Images should have alternate text (alt text)(MD045, no-alt-text)
536-536: null
Images should have alternate text (alt text)(MD045, no-alt-text)
550-550: null
Images should have alternate text (alt text)(MD045, no-alt-text)
575-575: null
Images should have alternate text (alt text)(MD045, no-alt-text)
579-579: null
Images should have alternate text (alt text)(MD045, no-alt-text)
601-601: null
Images should have alternate text (alt text)(MD045, no-alt-text)
607-607: null
Images should have alternate text (alt text)(MD045, no-alt-text)
625-625: null
Images should have alternate text (alt text)(MD045, no-alt-text)
README.md (6)
73-90: Improved Installation InstructionsThe updated installation instructions for macOS and Linux provide clearer guidance on downloading and installing the Espressif-IDE. The addition of prerequisites information is helpful for users.
Consider adding a comma after "Following this" in line 78 to improve readability:
-* To begin, download the [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE.md#downloads) for your respective operating system. Following this launch the IDE and proceed to install the necessary ESP-IDF and related tools. Please note that prior to launching the IDE, you must ensure that Java, Python, and Git are installed as [prerequisites](#Prerequisites), and are available in the system path. +* To begin, download the [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE.md#downloads) for your respective operating system. Following this, launch the IDE and proceed to install the necessary ESP-IDF and related tools. Please note that prior to launching the IDE, you must ensure that Java, Python, and Git are installed as [prerequisites](#Prerequisites), and are available in the system path.🧰 Tools
🪛 LanguageTool
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
170-186: Excellent Addition: Configuring Build Target SectionThis new section provides clear instructions on how to select and configure the ESP target for a project. The step-by-step guidance and the included image are very helpful for users.
Consider adding a brief explanation of what a "launch target" is and why it's important to select the correct one. This could help users better understand the purpose of this configuration step.
🧰 Tools
🪛 Markdownlint
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
211-234: Improved Serial Output Viewing InstructionsThe updated "Viewing Serial Output" section provides clear and easy-to-follow instructions on how to configure and use the ESP-IDF Serial Monitor. The addition of the image helps to visualize the process, and the link to more details about IDF Monitor is helpful for users who need additional information.
Consider adding a brief explanation of what the "Filter Options" are in step 4 and how they can be useful. This could help users make better use of this feature.
🧰 Tools
🪛 Markdownlint
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
235-252: Excellent Update: Debugging the Project SectionThe "Debugging the Project" section has been significantly improved. It now provides a simplified approach to starting debugging an ESP-IDF project, with clear and concise instructions. The addition of the image helps to visualize the debugging process, which is particularly helpful for new users.
Consider adding a brief explanation of what GDB OpenOCD Debugging is and why it's used for ESP-IDF projects. This could help users better understand the debugging process and its importance.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~243-~243: Possible missing comma found.
Context: ...ew for the new debug configuration will open where it's necessary to check the board...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
253-783: Comprehensive Update to Other IDE FeaturesThe "Other IDE Features" section has been well updated with minor changes and additions that improve clarity and provide more detailed information about various features.
Notably, the addition of new features such as the NVS Table Editor and Write Binary to Flash functionality adds significant value to the plugin. These features will likely be very useful for many users working with ESP-IDF projects.
Consider adding a brief summary at the beginning of this section to highlight the most important or commonly used features. This could help users quickly find the information they need.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~762-~762: Possible missing comma found.
Context: ...binary (Chooseencryptto encrypt the binary and disable thegenerate keyoption t...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~775-~775: Possible missing comma found.
Context: ...ESP-IDF>Write Binary Data to Flash` command accessible by right click on the projec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~775-~775: The verb “right-click” is spelled with a hyphen.
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...(CLICK_HYPHEN)
[style] ~783-~783: This phrase is redundant. Consider using “inside”.
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...(OUTSIDE_OF)
🪛 Markdownlint
742-742: Column: 1
Hard tabs(MD010, no-hard-tabs)
743-743: Column: 1
Hard tabs(MD010, no-hard-tabs)
744-744: Column: 1
Hard tabs(MD010, no-hard-tabs)
745-745: Column: 1
Hard tabs(MD010, no-hard-tabs)
755-755: Column: 1
Hard tabs(MD010, no-hard-tabs)
760-760: Column: 1
Hard tabs(MD010, no-hard-tabs)
764-764: Column: 1
Hard tabs(MD010, no-hard-tabs)
766-766: Column: 1
Hard tabs(MD010, no-hard-tabs)
768-768: Column: 1
Hard tabs(MD010, no-hard-tabs)
741-741: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
814-829: Useful Addition: Custom IDE ConfigurationThe "Custom IDE Configuration" section, particularly the instructions for setting up a custom build directory, is a valuable addition to the README. The instructions are clear, and the included image helps visualize the process.
Consider adding a brief explanation of why a user might want to use a custom build directory. This could help users understand the benefits and use cases for this feature.
🧰 Tools
🪛 LanguageTool
[style] ~808-~808: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en tick mark. 3. Click onDetails. 4. Click onSummaryon the left. 5. Scroll dow...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~818-~818: Possible missing comma found.
Context: ...onfigurationEditbutton from the top toolbar and this will launch the `Edit Configur...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~820-~820: Possible missing article found.
Context: ...tom build path>` with an absolute path. Customized build directory path could be within th...(AI_HYDRA_LEO_MISSING_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- README.md (29 hunks)
- README_CN.md (7 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
[uncategorized] ~150-~150: Possible missing article found.
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...(AI_HYDRA_LEO_MISSING_THE)
[style] ~152-~152: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... made. > Note Please note that you can not delete an active ESP-IDF version. You n...(CAN_NOT_PREMIUM)
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode. 3. Select your application from the second drop-d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~193-~193: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unch Configuration` (Auto-detected). 4. Select a target from the third drop-down, whic...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~243-~243: Possible missing comma found.
Context: ...ew for the new debug configuration will open where it's necessary to check the board...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~258-~258: Two consecutive dots
Context: ...pective fromWindow>Perspective>Reset Perspective..). 3. Provide theProject name. 4. Cl...(DOUBLE_PUNCTUATION)
[uncategorized] ~265-~265: Possible missing comma found.
Context: ...t of unresolved inclusion errors in the editor and those will be resolved only after t...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~336-~336: Possible missing comma found.
Context: ... in which you want to add the component to and selectInstall ESP-IDF Components...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~346-~346: Possible missing comma found.
Context: ... Already added components are also shown but theInstallbutton changes text to `A...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~402-~402: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...toolchain now is an experimental feature and you may face some build issues due to t...(COMMA_COMPOUND_SENTENCE)
[typographical] ~402-~402: Consider adding a comma here.
Context: ...irty). To work around clang build errors please refer to [this](https://github.com/espr...(PLEASE_COMMA)
[uncategorized] ~429-~429: Possible missing comma found.
Context: ...rom the drop-down menu. 3. From the sub menu select the language you want. 4. IDE wi...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~443-~443: Consider a more expressive alternative.
Context: ... you can still use the hints viewer. To do it, you have to manually download the `...(DO_ACHIEVE)
[style] ~444-~444: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...heRawbutton and thenSave as.... To open the hints viewer, go toWindows...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~449-~449: Did you mean “copy and paste”?
Context: ...-79af28c50c55.png) Now you can type or copy paste some error from the build log, for exam...(COPY_PASTE)
[uncategorized] ~563-~563: Possible missing comma found.
Context: ...an existing configuration with the same name then select `Overwrite existing launch ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~563-~563: ‘without warning’ might be wordy. Consider a shorter alternative.
Context: ...guration with the same name then selectOverwrite existing launch configurations without warning. 8. Click onFinish. <a name="gdbSt...(EN_WORDINESS_PREMIUM_WITHOUT_WARNING)
[uncategorized] ~605-~605: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ted. Remember that this is a panic mode and you can not continue the execution from...(COMMA_COMPOUND_SENTENCE)
[style] ~605-~605: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ember that this is a panic mode and you can not continue the execution from here, you w...(CAN_NOT_PREMIUM)
[uncategorized] ~609-~609: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...debug_panic_mode.png) You can view the registers stack trace and even view the value of ...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~629-~629: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ion in the core dump. You can view the registers stack trace and even view the value of ...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~691-~691: Loose punctuation mark.
Context: ...file://path/to/file``. *poll_period`: Data polling period (in ms) for availab...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~691-~691: Possible missing article found.
Context: ...ble trace data. If greater than 0, then command runs in non-blocking mode. By default, ...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~692-~692: Loose punctuation mark.
Context: ... mode. By default, 1 ms. *trace_size: Maximum size of data to collect (in byt...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~692-~692: Possible missing article found.
Context: ...ct (in bytes). Tracing is stopped after specified amount of data is received. By default ...(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~692-~692: Possible missing comma found.
Context: ...pecified amount of data is received. By default -1 (trace size stop trigger is disabled...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~693-~693: Loose punctuation mark.
Context: ...stop trigger is disabled). *stop_tmo: Idle timeout (in sec). Tracing is stopp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~694-~694: Loose punctuation mark.
Context: ...commands from the target. *wait4halt: If 0, start tracing immediately, otherw...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~762-~762: Possible missing comma found.
Context: ...binary (Chooseencryptto encrypt the binary and disable thegenerate keyoption t...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~775-~775: Possible missing comma found.
Context: ...ESP-IDF>Write Binary Data to Flash` command accessible by right click on the projec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~775-~775: The verb “right-click” is spelled with a hyphen.
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...(CLICK_HYPHEN)
[style] ~783-~783: This phrase is redundant. Consider using “inside”.
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...(OUTSIDE_OF)
[style] ~808-~808: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en tick mark. 3. Click onDetails. 4. Click onSummaryon the left. 5. Scroll dow...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~818-~818: Possible missing comma found.
Context: ...onfigurationEditbutton from the top toolbar and this will launch the `Edit Configur...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~820-~820: Possible missing article found.
Context: ...tom build path>` with an absolute path. Customized build directory path could be within th...(AI_HYDRA_LEO_MISSING_THE)
README_CN.md
[uncategorized] ~130-~130: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：适当"地"可
Context: ...统路径中，则将预加载到以上界面中；如果没有，请点击浏览，在文件夹中选择适当的可执行文件。 3. 点击完成。该按钮将在所有路径和可执行文件得到正确配置...(wb4)
[uncategorized] ~148-~148: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...DF_Manager_Multiple_versions.png) 若想激活某一版本，请点击激活列中对应的单选按钮。 编辑器中中最后一列的刷新按钮可用于重...(wa5)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"启动
Context: ...sb-drivers)。 创建调试配置的最快方式是展开启动栏中的配置列表并点击新的启动配置...。然后选择ESP-IDF GDB OpenOCD 调试-...(wb4)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"调试
Context: ...DF GDB OpenOCD 调试-> 双击或点击下一步`。接下来会打开新的调试配置预览页面，请仔细检查开发板的设置。 创建调试配置后就可以开始调试项目了...(wb4)
[uncategorized] ~533-~533: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"更新
Context: ...以按照以下步骤获取更新。 1. 前往帮助>检查更新。 2. 如有新的更新，请选择ESP-IDF Eclipse 插件，并取消勾选所有其他项目。...(wb4)
[uncategorized] ~803-~803: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"开发
Context: ...insUsingLocalFile">介绍进行安装。 # 如何获得最新的开发构建 1. 前往最新 master 分支，找到 <a href="http...(wb4)
🪛 Markdownlint
README.md
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
510-510: null
Bare URL used(MD034, no-bare-urls)
505-505: null
Images should have alternate text (alt text)(MD045, no-alt-text)
527-527: null
Bare URL used(MD034, no-bare-urls)
536-536: null
Images should have alternate text (alt text)(MD045, no-alt-text)
550-550: null
Images should have alternate text (alt text)(MD045, no-alt-text)
575-575: null
Images should have alternate text (alt text)(MD045, no-alt-text)
587-587: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
594-594: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
601-601: null
Images should have alternate text (alt text)(MD045, no-alt-text)
607-607: null
Images should have alternate text (alt text)(MD045, no-alt-text)
625-625: null
Images should have alternate text (alt text)(MD045, no-alt-text)
691-691: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
692-692: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
693-693: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
694-694: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
691-691: Column: 1
Hard tabs(MD010, no-hard-tabs)
692-692: Column: 1
Hard tabs(MD010, no-hard-tabs)
693-693: Column: 1
Hard tabs(MD010, no-hard-tabs)
694-694: Column: 1
Hard tabs(MD010, no-hard-tabs)
742-742: Column: 1
Hard tabs(MD010, no-hard-tabs)
743-743: Column: 1
Hard tabs(MD010, no-hard-tabs)
744-744: Column: 1
Hard tabs(MD010, no-hard-tabs)
745-745: Column: 1
Hard tabs(MD010, no-hard-tabs)
755-755: Column: 1
Hard tabs(MD010, no-hard-tabs)
760-760: Column: 1
Hard tabs(MD010, no-hard-tabs)
764-764: Column: 1
Hard tabs(MD010, no-hard-tabs)
766-766: Column: 1
Hard tabs(MD010, no-hard-tabs)
768-768: Column: 1
Hard tabs(MD010, no-hard-tabs)
741-741: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
843-843: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
844-844: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
845-845: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
846-846: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
README_CN.md
226-226: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
299-299: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
300-300: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
296-296: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
362-362: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
378-378: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
80-80: null
Bare URL used(MD034, no-bare-urls)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
309-309: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
313-313: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
289-289: null
Images should have alternate text (alt text)(MD045, no-alt-text)
293-293: null
Images should have alternate text (alt text)(MD045, no-alt-text)
311-311: null
Images should have alternate text (alt text)(MD045, no-alt-text)
315-315: null
Images should have alternate text (alt text)(MD045, no-alt-text)
329-329: null
Images should have alternate text (alt text)(MD045, no-alt-text)
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
353-353: null
Images should have alternate text (alt text)(MD045, no-alt-text)
375-375: null
Images should have alternate text (alt text)(MD045, no-alt-text)
389-389: null
Images should have alternate text (alt text)(MD045, no-alt-text)
638-638: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
639-639: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
508-508: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
539-539: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
510-510: null
Bare URL used(MD034, no-bare-urls)
527-527: null
Bare URL used(MD034, no-bare-urls)
587-587: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
594-594: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
467-467: null
Images should have alternate text (alt text)(MD045, no-alt-text)
475-475: null
Images should have alternate text (alt text)(MD045, no-alt-text)
489-489: null
Images should have alternate text (alt text)(MD045, no-alt-text)
505-505: null
Images should have alternate text (alt text)(MD045, no-alt-text)
518-518: null
Images should have alternate text (alt text)(MD045, no-alt-text)
536-536: null
Images should have alternate text (alt text)(MD045, no-alt-text)
550-550: null
Images should have alternate text (alt text)(MD045, no-alt-text)
575-575: null
Images should have alternate text (alt text)(MD045, no-alt-text)
579-579: null
Images should have alternate text (alt text)(MD045, no-alt-text)
601-601: null
Images should have alternate text (alt text)(MD045, no-alt-text)
607-607: null
Images should have alternate text (alt text)(MD045, no-alt-text)
625-625: null
Images should have alternate text (alt text)(MD045, no-alt-text)
654-654: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
655-655: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
656-656: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
690-690: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
691-691: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
692-692: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
693-693: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
694-694: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
695-695: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
654-654: Column: 1
Hard tabs(MD010, no-hard-tabs)
655-655: Column: 1
Hard tabs(MD010, no-hard-tabs)
656-656: Column: 1
Hard tabs(MD010, no-hard-tabs)
690-690: Column: 1
Hard tabs(MD010, no-hard-tabs)
691-691: Column: 1
Hard tabs(MD010, no-hard-tabs)
692-692: Column: 1
Hard tabs(MD010, no-hard-tabs)
693-693: Column: 1
Hard tabs(MD010, no-hard-tabs)
694-694: Column: 1
Hard tabs(MD010, no-hard-tabs)
695-695: Column: 1
Hard tabs(MD010, no-hard-tabs)
722-722: Column: 1
Hard tabs(MD010, no-hard-tabs)
724-724: Column: 1
Hard tabs(MD010, no-hard-tabs)
726-726: Column: 1
Hard tabs(MD010, no-hard-tabs)
742-742: Column: 1
Hard tabs(MD010, no-hard-tabs)
743-743: Column: 1
Hard tabs(MD010, no-hard-tabs)
744-744: Column: 1
Hard tabs(MD010, no-hard-tabs)
745-745: Column: 1
Hard tabs(MD010, no-hard-tabs)
755-755: Column: 1
Hard tabs(MD010, no-hard-tabs)
760-760: Column: 1
Hard tabs(MD010, no-hard-tabs)
764-764: Column: 1
Hard tabs(MD010, no-hard-tabs)
766-766: Column: 1
Hard tabs(MD010, no-hard-tabs)
768-768: Column: 1
Hard tabs(MD010, no-hard-tabs)
741-741: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
674-674: null
Images should have alternate text (alt text)(MD045, no-alt-text)
678-678: null
Images should have alternate text (alt text)(MD045, no-alt-text)
682-682: null
Images should have alternate text (alt text)(MD045, no-alt-text)
699-699: null
Images should have alternate text (alt text)(MD045, no-alt-text)
710-710: null
Images should have alternate text (alt text)(MD045, no-alt-text)
825-825: null
Images should have alternate text (alt text)(MD045, no-alt-text)
843-843: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
844-844: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
845-845: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
846-846: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
🔇 Additional comments (9)
README_CN.md (1)
Line range hint
20-63: Excellent restructuring of the table of contents!The expanded and reorganized table of contents significantly improves document navigation. The addition of new sections like "ESP-IDF Components" and "Wokwi Simulator" reflects the plugin's enhanced features, making it easier for users to find relevant information.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~130-~130: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：适当"地"可
Context: ...统路径中，则将预加载到以上界面中；如果没有，请点击浏览，在文件夹中选择适当的可执行文件。 3. 点击完成。该按钮将在所有路径和可执行文件得到正确配置...(wb4)
[uncategorized] ~148-~148: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...DF_Manager_Multiple_versions.png) 若想激活某一版本，请点击激活列中对应的单选按钮。 编辑器中中最后一列的刷新按钮可用于重...(wa5)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"启动
Context: ...sb-drivers)。 创建调试配置的最快方式是展开启动栏中的配置列表并点击新的启动配置...。然后选择ESP-IDF GDB OpenOCD 调试-...(wb4)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"调试
Context: ...DF GDB OpenOCD 调试-> 双击或点击下一步`。接下来会打开新的调试配置预览页面，请仔细检查开发板的设置。 创建调试配置后就可以开始调试项目了...(wb4)
🪛 Markdownlint
226-226: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
299-299: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
300-300: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
296-296: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
362-362: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
378-378: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
80-80: null
Bare URL used(MD034, no-bare-urls)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
309-309: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
313-313: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
289-289: null
Images should have alternate text (alt text)(MD045, no-alt-text)
293-293: null
Images should have alternate text (alt text)(MD045, no-alt-text)
311-311: null
Images should have alternate text (alt text)(MD045, no-alt-text)
315-315: null
Images should have alternate text (alt text)(MD045, no-alt-text)
329-329: null
Images should have alternate text (alt text)(MD045, no-alt-text)
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
353-353: null
Images should have alternate text (alt text)(MD045, no-alt-text)
375-375: null
Images should have alternate text (alt text)(MD045, no-alt-text)
389-389: null
Images should have alternate text (alt text)(MD045, no-alt-text)
418-418: null
Images should have alternate text (alt text)(MD045, no-alt-text)
README.md (8)
Line range hint
1-63: LGTM: Introduction and Table of ContentsThe introduction provides a clear overview of the ESP-IDF Eclipse Plugin. The changes in the table of contents appear to be minor adjustments to line numbers, which is expected due to content shifts in the document.
🧰 Tools
🪛 LanguageTool
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
[uncategorized] ~150-~150: Possible missing article found.
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...(AI_HYDRA_LEO_MISSING_THE)
[style] ~152-~152: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... made. > Note Please note that you can not delete an active ESP-IDF version. You n...(CAN_NOT_PREMIUM)
🪛 Markdownlint
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
155-170: LGTM: Create a new Project InstructionsThe instructions for creating a new project are clear and concise. The note about unresolved headers and symbols is helpful for users, as it sets the right expectations during the project creation process.
🧰 Tools
🪛 LanguageTool
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
[uncategorized] ~150-~150: Possible missing article found.
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...(AI_HYDRA_LEO_MISSING_THE)
[style] ~152-~152: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... made. > Note Please note that you can not delete an active ESP-IDF version. You n...(CAN_NOT_PREMIUM)
🪛 Markdownlint
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
187-210: LGTM: Compiling and Flashing InstructionsThe instructions for compiling and flashing the project are clear and concise. The addition of the image illustrating the flashing process is particularly helpful for users. The link to the JTAG Flashing Guide provides valuable additional information for advanced users.
🧰 Tools
🪛 LanguageTool
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode. 3. Select your application from the second drop-d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~193-~193: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unch Configuration` (Auto-detected). 4. Select a target from the third drop-down, whic...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~202-~202: This word is normally spelled as one.
Context: ...s_readme/images/icons/run.png) and it's auto-configured to flash the application with the defau...(EN_COMPOUNDS_AUTO_CONFIGURED)
🪛 Markdownlint
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
785-799: LGTM: How to Build Locally InstructionsThe "How to build locally" section provides clear and straightforward instructions for developers who want to build the plugin locally. The inclusion of the necessary commands and information about the generated artifact is particularly helpful.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~762-~762: Possible missing comma found.
Context: ...binary (Chooseencryptto encrypt the binary and disable thegenerate keyoption t...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~775-~775: Possible missing comma found.
Context: ...ESP-IDF>Write Binary Data to Flash` command accessible by right click on the projec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~775-~775: The verb “right-click” is spelled with a hyphen.
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...(CLICK_HYPHEN)
[style] ~783-~783: This phrase is redundant. Consider using “inside”.
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...(OUTSIDE_OF)
🪛 Markdownlint
742-742: Column: 1
Hard tabs(MD010, no-hard-tabs)
743-743: Column: 1
Hard tabs(MD010, no-hard-tabs)
744-744: Column: 1
Hard tabs(MD010, no-hard-tabs)
745-745: Column: 1
Hard tabs(MD010, no-hard-tabs)
755-755: Column: 1
Hard tabs(MD010, no-hard-tabs)
760-760: Column: 1
Hard tabs(MD010, no-hard-tabs)
764-764: Column: 1
Hard tabs(MD010, no-hard-tabs)
766-766: Column: 1
Hard tabs(MD010, no-hard-tabs)
768-768: Column: 1
Hard tabs(MD010, no-hard-tabs)
741-741: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
801-812: LGTM: Latest Development Build InstructionsThe "How do I get the latest development build" section provides clear and easy-to-follow instructions for users who want to access the most recent features and fixes. The link to the installation instructions is a helpful addition.
🧰 Tools
🪛 LanguageTool
[style] ~808-~808: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en tick mark. 3. Click onDetails. 4. Click onSummaryon the left. 5. Scroll dow...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~818-~818: Possible missing comma found.
Context: ...onfigurationEditbutton from the top toolbar and this will launch the `Edit Configur...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~820-~820: Possible missing article found.
Context: ...tom build path>` with an absolute path. Customized build directory path could be within th...(AI_HYDRA_LEO_MISSING_THE)
831-837: LGTM: Wokwi Simulator InstructionsThe "Wokwi Simulator" section provides clear and comprehensive instructions on how to use the Wokwi Simulator with the ESP-IDF Eclipse Plugin. The step-by-step guide covers everything from installation to usage, and the explanation of how to find the Wokwi project ID is particularly helpful.
Line range hint
852-854: LGTM: Bug Reporting InstructionsThe "How to raise bugs" section provides clear and concise instructions for users to report issues with the plugin. The inclusion of the link to the GitHub issues page is helpful and makes it easy for users to submit their bug reports.
Line range hint
1-854: Excellent Updates to the READMEThe README file has been significantly improved with new sections, updated instructions, and clearer explanations. These changes will greatly enhance the user experience for those working with the ESP-IDF Eclipse Plugin.
Key improvements include:
- More detailed installation instructions
- Clearer guidance on configuring and using various features
- Addition of new sections like "Configuring build target" and "Wokwi Simulator"
- Updated compatibility matrix
While there are a few minor issues (mostly formatting and typos), these are easily addressable and do not detract from the overall quality of the document.
Great work on improving the documentation! These updates will be very helpful for both new and experienced users of the ESP-IDF Eclipse Plugin.
🧰 Tools
🪛 LanguageTool
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
[uncategorized] ~150-~150: Possible missing article found.
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...(AI_HYDRA_LEO_MISSING_THE)
[style] ~152-~152: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... made. > Note Please note that you can not delete an active ESP-IDF version. You n...(CAN_NOT_PREMIUM)
🪛 Markdownlint
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
|
|
||
| # Installing ESP-IDF | ||
|
|
||
| Please follow the instructions below for installing ESP-IDF in the Espressif-IDE. | ||
|
|
||
| 1. Go to `Espressif` > `ESP-IDF Manager`. The following editor will open | ||
|
|
||
|  | ||
|
|
||
| 1. Click on `Add ESP-IDF` button. | ||
| 2. Click on `Add ESP-IDF` button. | ||
|
|
||
|  | ||
| From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables. | ||
|
|
||
| 1. Click on `Finish` which will be enabled after all the paths and executables are properly configured. | ||
| From the screen shown above you can either choose an already downloaded ESP-IDF directory or select and download one directly from the given dialog. The `Git` and `Python` must be installed and if they are configured in system PATH, they will be preloaded in the given view. If not, you can Browse to the directory and select the proper executables. | ||
|
|
||
| 3. Click on `Finish`, which will be enabled after all the paths and executables are properly configured. | ||
|
|
||
| > **Note** Please note that the python executable is not the one from the virtual environment created from the installation of the ESP-IDF via other means like from CLI. If you are selecting an already installed ESP-IDF directory, IDE will automatically pick up the python once you have installed the tools. | ||
|
|
||
| > **Note** Please note that the python executable is not the one from the virtual environment created from the installation of the ESP-IDF via other means like from CLI. If you are selecting an already installed ESP-IDF directory IDE will automatically pick up the python once you have installed the tools. | ||
| To configure an existing ESP-IDF: | ||
|
|
||
| After you have clicked `Finish` you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE it will be activated as well and you will see a similar entry in the editor for ESP-IDF Manager | ||
| After you have clicked `Finish`, you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE, it will be activated as well, and you will see a similar entry in the editor for ESP-IDF Manager. | ||
|
|
||
|  | ||
|
|
||
| You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. | ||
| You can add as many version of ESP-IDF as you want, but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. | ||
|
|
||
| Let's take a look at how the multiple versions will look like. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE. |
There was a problem hiding this comment.
Improved ESP-IDF Installation Instructions
The updated instructions for installing and configuring ESP-IDF provide clearer guidance. The explanation of the Python executable selection is particularly helpful for users.
There's a minor typo in line 142. Please correct "swithcing" to "switching":
-You can add as many version of ESP-IDF as you want, but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily.
+You can add as many versions of ESP-IDF as you want, but only one of the versions can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in switching between versions in the workspace easily.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Installing ESP-IDF | |
| Please follow the instructions below for installing ESP-IDF in the Espressif-IDE. | |
| 1. Go to `Espressif` > `ESP-IDF Manager`. The following editor will open | |
|  | |
| 1. Click on `Add ESP-IDF` button. | |
| 2. Click on `Add ESP-IDF` button. | |
|  | |
| From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables. | |
| 1. Click on `Finish` which will be enabled after all the paths and executables are properly configured. | |
| From the screen shown above you can either choose an already downloaded ESP-IDF directory or select and download one directly from the given dialog. The `Git` and `Python` must be installed and if they are configured in system PATH, they will be preloaded in the given view. If not, you can Browse to the directory and select the proper executables. | |
| 3. Click on `Finish`, which will be enabled after all the paths and executables are properly configured. | |
| > **Note** Please note that the python executable is not the one from the virtual environment created from the installation of the ESP-IDF via other means like from CLI. If you are selecting an already installed ESP-IDF directory, IDE will automatically pick up the python once you have installed the tools. | |
| > **Note** Please note that the python executable is not the one from the virtual environment created from the installation of the ESP-IDF via other means like from CLI. If you are selecting an already installed ESP-IDF directory IDE will automatically pick up the python once you have installed the tools. | |
| To configure an existing ESP-IDF: | |
| After you have clicked `Finish` you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE it will be activated as well and you will see a similar entry in the editor for ESP-IDF Manager | |
| After you have clicked `Finish`, you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE, it will be activated as well, and you will see a similar entry in the editor for ESP-IDF Manager. | |
|  | |
| You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. | |
| You can add as many version of ESP-IDF as you want, but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. | |
| Let's take a look at how the multiple versions will look like. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE. | |
| # Installing ESP-IDF | |
| Please follow the instructions below for installing ESP-IDF in the Espressif-IDE. | |
| 1. Go to `Espressif` > `ESP-IDF Manager`. The following editor will open | |
|  | |
| 2. Click on `Add ESP-IDF` button. | |
|  | |
| From the screen shown above you can either choose an already downloaded ESP-IDF directory or select and download one directly from the given dialog. The `Git` and `Python` must be installed and if they are configured in system PATH, they will be preloaded in the given view. If not, you can Browse to the directory and select the proper executables. | |
| 3. Click on `Finish`, which will be enabled after all the paths and executables are properly configured. | |
| > **Note** Please note that the python executable is not the one from the virtual environment created from the installation of the ESP-IDF via other means like from CLI. If you are selecting an already installed ESP-IDF directory, IDE will automatically pick up the python once you have installed the tools. | |
| To configure an existing ESP-IDF: | |
| After you have clicked `Finish`, you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE, it will be activated as well, and you will see a similar entry in the editor for ESP-IDF Manager. | |
|  | |
| You can add as many versions of ESP-IDF as you want, but only one of the versions can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in switching between versions in the workspace easily. | |
| Let's take a look at how the multiple versions will look like. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
🪛 Markdownlint
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
| # ESP-IDF Eclipse Plugin Compatibility Matrix | ||
|
|
||
| | IEP | Eclipse | Java | Installer | Description | | ||
| | ------ | ------ | ------ |------ | ------ | | ||
| | IEP 2.12.1 | Eclipse 2023-03 to Eclipse 2023-12 |Java 17 and above |[espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.12.1-esp-idf-5.2/espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe) | | ||
| | IEP 2.12.0 | Eclipse 2023-03, Eclipse 2023-06, Eclipse 2023-09 |Java 17 and above | [espressif-ide-setup-2.12.0-with-esp-idf-5.1.2](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.12.0-esp-idf-5.1.2/espressif-ide-setup-2.12.0-with-esp-idf-5.1.2.exe) | | ||
| | IEP 2.11.0 | Eclipse 2023-03, Eclipse 2023-06, Eclipse 2023-09 |Java 17 and above |[espressif-ide-setup-2.11.0-with-esp-idf-5.1.1.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.11.0-esp-idf-5.1.1/espressif-ide-setup-2.11.0-with-esp-idf-5.1.1.exe) | | ||
| | IEP 2.10.0 | Eclipse 2022-09,2022-12,2023-03 |Java 17 and above | [espressif-ide-setup-2.10.0-with-esp-idf-5.0.1.exe](https://github.com/espressif/idf-installer/releases/download/untagged-52aeb689780472c126c1/espressif-ide-setup-2.10.0-with-esp-idf-5.0.1.exe)| | ||
| | IEP 2.9.1 | Eclipse 2022-09 and Eclipse 2022-12 |Java 17 and above | [espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.9.0-esp-idf-5.0.1/espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe) | For Windows Users, it's recommended to use the Windows Offline Installer and upgrade to the latest IEP v2.9.1 plugin| | ||
| | IEP 2.12.0 | Eclipse 2023-03, 2023-06, 2023-09 |Java 17 and above | [espressif-ide-setup-2.12.0-with-esp-idf-5.1.2](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.12.0-esp-idf-5.1.2/espressif-ide-setup-2.12.0-with-esp-idf-5.1.2.exe) | | ||
| | IEP 2.11.0 | Eclipse 2023-03, 2023-06, 2023-09 |Java 17 and above |[espressif-ide-setup-2.11.0-with-esp-idf-5.1.1.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.11.0-esp-idf-5.1.1/espressif-ide-setup-2.11.0-with-esp-idf-5.1.1.exe) | | ||
| | IEP 2.10.0 | Eclipse 2022-09, 2022-12, 2023-03 |Java 17 and above | [espressif-ide-setup-2.10.0-with-esp-idf-5.0.1.exe](https://github.com/espressif/idf-installer/releases/download/untagged-52aeb689780472c126c1/espressif-ide-setup-2.10.0-with-esp-idf-5.0.1.exe)| | ||
| | IEP 2.9.1 | Eclipse 2022-09 and Eclipse 2022-12 |Java 17 and above | [espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.9.0-esp-idf-5.0.1/espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe) | For Windows Users, it's recommended to use the Windows Offline Installer and upgrade to the latest IEP v2.9.1 plugin| |
There was a problem hiding this comment.
Useful Compatibility Matrix with Minor Formatting Issues
The ESP-IDF Eclipse Plugin Compatibility Matrix is a valuable addition to the README, providing users with clear information about compatible versions of Eclipse, Java, and corresponding installers.
There are some formatting issues in the table that need to be addressed:
- Some rows are missing the "Description" column. Please add this column to all rows for consistency.
- Ensure all rows have the same number of columns (5) by adding empty cells where necessary.
Here's an example of how to fix the first row:
-| IEP 2.12.1 | Eclipse 2023-03 to Eclipse 2023-12 |Java 17 and above |[espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.12.1-esp-idf-5.2/espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe) |
+| IEP 2.12.1 | Eclipse 2023-03 to Eclipse 2023-12 | Java 17 and above | [espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.12.1-esp-idf-5.2/espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe) | |Apply similar fixes to the other rows in the table.
Committable suggestion was skipped due to low confidence.
🧰 Tools
🪛 Markdownlint
843-843: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
844-844: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
845-845: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
846-846: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
Shen765
force-pushed
the
docs/update_readme_cn
branch
from
7ac99a2
to
1cfc9bc
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (21)
README_CN.md (12)
68-92: Clear and comprehensive installation instructionsThe installation section provides clear guidance for different operating systems:
- The recommendation to use Espressif-IDE is helpful.
- Separate instructions for Windows, macOS, and Linux are provided.
- Prerequisites for macOS and Linux are mentioned.
Consider adding a brief explanation of why Espressif-IDE is recommended over Eclipse CDT + IEP plugin updates. This would help users understand the benefits of this approach.
🧰 Tools
🪛 Markdownlint
80-80: null
Bare URL used(MD034, no-bare-urls)
96-114: Comprehensive plugin installation instructionsThis section provides clear, step-by-step guidance for installing the IDF plugin:
- Instructions are detailed and easy to follow.
- URLs for stable, beta, and nightly builds are provided, catering to different user needs.
- The note about cross-platform applicability of screenshots is helpful.
Consider adding a brief explanation of the differences between stable, beta, and nightly builds to help users choose the appropriate version for their needs.
🧰 Tools
🪛 Markdownlint
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
155-167: Clear instructions for creating a new projectThis section effectively guides users through the process of creating a new project:
- Step-by-step instructions are concise and easy to follow.
- The note about potential unresolved errors after project creation is helpful for new users.
- The reference to template-based project creation provides a useful alternative.
Consider adding a brief explanation of why unresolved errors might appear initially and when users can expect them to be resolved (e.g., after the first build). This could help alleviate potential user concerns.
🧰 Tools
🪛 Markdownlint
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
171-184: Clear guidance on configuring build targetsThis section effectively explains how to configure build targets:
- Instructions for selecting an existing target are straightforward.
- The process for adding a new target is clearly explained.
- The included screenshot provides helpful visual guidance.
Consider adding a brief note about the importance of selecting the correct target for the project, and how it affects the build and flash process. This could help users understand the significance of this step.
🧰 Tools
🪛 Markdownlint
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
187-196: Comprehensive project build instructionsThis section provides clear and detailed guidance for building a project:
- Step-by-step instructions cover all necessary aspects of the build process.
- The explanation of selecting launch mode, configuration, and target is helpful.
- The included screenshot offers valuable visual reference.
Consider adding a note about common build errors and how to troubleshoot them, or link to a troubleshooting section if one exists. This could save users time when encountering issues during the build process.
🧰 Tools
🪛 Markdownlint
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
199-208: Clear and concise flashing instructionsThis section effectively explains the project flashing process:
- The use of the 'Launch' button for flashing is clearly explained.
- The default flash command is mentioned, which is helpful for understanding the process.
- The reference to customizing flash parameters caters to advanced users.
- The included screenshot provides useful visual guidance.
Consider adding a brief note about the importance of selecting the correct port and baud rate for flashing, and how to verify that the device is properly connected before flashing. This could help prevent common flashing issues.
🧰 Tools
🪛 Markdownlint
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
211-232: Comprehensive guide for serial output monitoringThis section provides excellent instructions for viewing serial output:
- Step-by-step guidance for configuring and using the ESP-IDF Serial Monitor is clear and detailed.
- The explanation of setting up serial monitor preferences is helpful for customization.
- Screenshots for both monitor setup and preferences provide valuable visual aids.
- The mention of integration with the IDF Monitor adds context for experienced users.
Consider adding a brief troubleshooting section or link to common issues users might encounter when setting up serial monitoring (e.g., port not found, permission issues). This could help users quickly resolve typical problems.
🧰 Tools
🪛 Markdownlint
226-226: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
235-249: Clear introduction to project debuggingThis section effectively introduces the debugging process for ESP-IDF projects:
- The overview of the debugging steps is concise and helpful.
- Instructions for creating a debug configuration are clear.
- The note about Windows driver requirements is crucial for preventing issues.
- The screenshot provides useful visual guidance.
- The reference to a detailed OpenOCD debugging guide is valuable for users needing more information.
Consider adding a brief explanation of common debugging scenarios or use cases. This could help users understand when and why they might need to use the debugger, especially for those new to embedded development.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"启动
Context: ...sb-drivers)。 创建调试配置的最快方式是展开启动栏中的配置列表并点击新的启动配置...。然后选择ESP-IDF GDB OpenOCD 调试-...(wb4)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"调试
Context: ...DF GDB OpenOCD 调试-> 双击或点击下一步`。接下来会打开新的调试配置预览页面，请仔细检查开发板的设置。 创建调试配置后就可以开始调试项目了...(wb4)
🪛 Markdownlint
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
251-293: Comprehensive overview of additional IDE featuresThis section effectively introduces various additional features of the IDE:
- The range of features covered is impressive, from project templates to CMake editing.
- Brief descriptions provide a good starting point for understanding each feature.
- Instructions for accessing each feature are generally clear.
Consider the following improvements:
- Add screenshots for some of the more complex features (e.g., SDK configuration editor, CMake editor) to provide visual context.
- Expand on the descriptions of some features, particularly those unique to ESP-IDF development, to help users understand their importance and use cases.
- Consider adding links to more detailed documentation for each feature, if available.
🧰 Tools
🪛 Markdownlint
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
289-289: null
Images should have alternate text (alt text)(MD045, no-alt-text)
293-293: null
Images should have alternate text (alt text)(MD045, no-alt-text)
295-304: Clear guidance on using the SDK Configuration EditorThis section effectively explains how to use the SDK Configuration Editor:
- Step-by-step instructions for opening and using the editor are clear and concise.
- Information on saving changes and reverting modifications is valuable for users.
- The screenshot provides excellent visual context for the editor interface.
Consider adding a brief explanation of some common or important configuration options that users might frequently modify. This could help new users understand the significance of the SDK Configuration Editor in the development process.
🧰 Tools
🪛 Markdownlint
299-299: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
300-300: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
296-296: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
Line range hint
295-855: Comprehensive coverage of additional features and functionalitiesThe remaining sections of the README provide valuable information on a wide range of topics:
- Each section offers clear, concise instructions or explanations for its respective feature.
- The use of screenshots and code snippets in some sections enhances understanding.
- The breadth of topics covered demonstrates the plugin's extensive capabilities.
Consider the following improvements for consistency and completeness:
- Standardize the depth of information across sections. Some topics (e.g., "应用层追踪") have more detailed explanations than others.
- Add more visual aids (screenshots, diagrams) to sections that currently lack them, where applicable.
- Include links to more detailed documentation or user guides for complex features, if available.
- Consider reorganizing the sections to group related topics together, which could improve navigation and readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~533-~533: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"更新
Context: ...以按照以下步骤获取更新。 1. 前往帮助>检查更新。 2. 如有新的更新，请选择ESP-IDF Eclipse 插件，并取消勾选所有其他项目。...(wb4)
🪛 Markdownlint
638-638: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
639-639: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
508-508: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
539-539: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
510-510: null
Bare URL used(MD034, no-bare-urls)
527-527: null
Bare URL used(MD034, no-bare-urls)
587-587: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
594-594: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
467-467: null
Images should have alternate text (alt text)(MD045, no-alt-text)
475-475: null
Images should have alternate text (alt text)(MD045, no-alt-text)
489-489: null
Images should have alternate text (alt text)(MD045, no-alt-text)
505-505: null
Images should have alternate text (alt text)(MD045, no-alt-text)
518-518: null
Images should have alternate text (alt text)(MD045, no-alt-text)
536-536: null
Images should have alternate text (alt text)(MD045, no-alt-text)
550-550: null
Images should have alternate text (alt text)(MD045, no-alt-text)
575-575: null
Images should have alternate text (alt text)(MD045, no-alt-text)
579-579: null
Images should have alternate text (alt text)(MD045, no-alt-text)
601-601: null
Images should have alternate text (alt text)(MD045, no-alt-text)
607-607: null
Images should have alternate text (alt text)(MD045, no-alt-text)
625-625: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Missing Anchors in Table of Contents
The verification script detected that the following anchors referenced in the table of contents do not have corresponding sections in the document:
#nvsTableEditor#partitionTableEditor#wokwisimulator#writeFlashBinaryPlease ensure that these sections exist in the document or update/remove the corresponding links in the table of contents.
🔗 Analysis chain
Line range hint
20-63: Well-structured table of contentsThe use of collapsible sections for the table of contents is excellent, improving navigation and readability. The division into "入门指南" and "其他 IDE 功能" provides a clear organization of the content.
To ensure all links are working correctly, please run the following script:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that all anchor links in the table of contents have corresponding sections in the document # Extract all anchor links from the table of contents toc_links=$(grep -oP '(?<=\(#)[^)]+' README_CN.md | sort | uniq) # Check if each anchor link has a corresponding section for link in $toc_links; do if ! grep -q "name=\"$link\"" README_CN.md; then echo "Warning: Anchor #$link not found in the document" fi doneLength of output: 3816
🧰 Tools
🪛 LanguageTool
[uncategorized] ~130-~130: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：适当"地"可
Context: ...统路径中，则将预加载到以上界面中；如果没有，请点击浏览，在文件夹中选择适当的可执行文件。 3. 点击完成。该按钮将在所有路径和可执行文件得到正确配置...(wb4)
[uncategorized] ~148-~148: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...DF_Manager_Multiple_versions.png) 若想激活某一版本，请点击激活列中对应的单选按钮。 编辑器中中最后一列的刷新按钮可用于重...(wa5)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"启动
Context: ...sb-drivers)。 创建调试配置的最快方式是展开启动栏中的配置列表并点击新的启动配置...。然后选择ESP-IDF GDB OpenOCD 调试-...(wb4)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"调试
Context: ...DF GDB OpenOCD 调试-> 双击或点击下一步`。接下来会打开新的调试配置预览页面，请仔细检查开发板的设置。 创建调试配置后就可以开始调试项目了...(wb4)
🪛 Markdownlint
226-226: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
299-299: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
300-300: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
296-296: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
362-362: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
378-378: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
80-80: null
Bare URL used(MD034, no-bare-urls)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
309-309: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
313-313: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
289-289: null
Images should have alternate text (alt text)(MD045, no-alt-text)
293-293: null
Images should have alternate text (alt text)(MD045, no-alt-text)
311-311: null
Images should have alternate text (alt text)(MD045, no-alt-text)
315-315: null
Images should have alternate text (alt text)(MD045, no-alt-text)
329-329: null
Images should have alternate text (alt text)(MD045, no-alt-text)
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
353-353: null
Images should have alternate text (alt text)(MD045, no-alt-text)
375-375: null
Images should have alternate text (alt text)(MD045, no-alt-text)
389-389: null
Images should have alternate text (alt text)(MD045, no-alt-text)
418-418: null
Images should have alternate text (alt text)(MD045, no-alt-text)
README.md (9)
40-63: Expanded and improved "Other IDE Features" sectionThe updates to this section provide a more comprehensive list of features with consistent formatting, enhancing the document's usefulness.
However, there's a minor typo in line 58 that needs correction:
-* [Application Level Tracing](#appLvlTracing)<br +* [Application Level Tracing](#appLvlTracing)<br>
69-80: Improved installation instructionsThe updated installation instructions provide clearer guidance for different operating systems and include helpful prerequisite information.
However, there's a minor wording issue that could be improved:
-* To begin, download the [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE.md#downloads) for your respective operating system. Following this, launch the IDE and proceed to install the necessary ESP-IDF and related tools. Please note that prior to launching the IDE, you must ensure that Java, Python, and Git are installed as [prerequisites](#Prerequisites), and are available in the system path. +* To begin, download the [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE.md#downloads) for your respective operating system. Following this, launch the IDE and proceed to install the necessary ESP-IDF and related tools. Please note that before launching the IDE, you must ensure that Java, Python, and Git are installed as [prerequisites](#Prerequisites), and are available in the system path.🧰 Tools
🪛 LanguageTool
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
96-110: Enhanced installation instructions with additional optionsThe updated instructions for installing the IDF Plugin using the update site URL are clear and well-structured. The addition of beta and nightly build URLs is helpful for advanced users.
For consistency in formatting, consider adjusting the indentation of the URLs:
If you've already installed IDF Eclipse Plugin using `update site URL`, you can get the latest changes by following the steps below: 1. `Help` > `Check for Updates`. 2. If updates are found, select `Espressif IDF Plugins for Eclipse` and deselect all other items. 3. Click `Next` to proceed with the installation. For adding beta and nightly builds, you can use the following update site URLs. - * Beta version: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/beta/ - * Nightly build: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/ +* Beta version: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/beta/ +* Nightly build: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/🧰 Tools
🪛 Markdownlint
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
117-152: Comprehensive ESP-IDF installation instructionsThe detailed instructions for installing ESP-IDF are well-structured and include helpful screenshots. However, there are a few minor issues that could be addressed:
- In line 130, consider adding a comma after "above".
- In line 138, add "the" before "console".
- In lines 142-144, there are some grammatical issues:
-You can add as many version of ESP-IDF as you want, but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. +You can add as many versions of ESP-IDF as you want, but only one of the versions can be set as active, and that will be used to compile and index projects in your workspace. This new feature can help you in switching between versions in the workspace easily. -Let's take a look at how the multiple versions will look like. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE. +Let's take a look at how the multiple versions will appear. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE.
- In line 150, add "the" before "last column".
- In line 152, replace "can not" with "cannot".
🧰 Tools
🪛 LanguageTool
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
[uncategorized] ~150-~150: Possible missing article found.
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...(AI_HYDRA_LEO_MISSING_THE)
[style] ~152-~152: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... made. > Note Please note that you can not delete an active ESP-IDF version. You n...(CAN_NOT_PREMIUM)
🪛 Markdownlint
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
155-170: Clear instructions for creating a new projectThe instructions for creating a new project are concise and easy to follow. The note about unresolved headers and symbols is helpful for users who might be concerned about initial errors.
There's a minor typographical error that should be corrected:
-2. Go to `File` > `New` > `Espressif IDF Project` (If you don't see this, please reset the perspective from `Window` > `Perspective` > `Reset Perspective..`). +2. Go to `File` > `New` > `Espressif IDF Project` (If you don't see this, please reset the perspective from `Window` > `Perspective` > `Reset Perspective...`).🧰 Tools
🪛 LanguageTool
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
[uncategorized] ~150-~150: Possible missing article found.
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...(AI_HYDRA_LEO_MISSING_THE)
[style] ~152-~152: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... made. > Note Please note that you can not delete an active ESP-IDF version. You n...(CAN_NOT_PREMIUM)
🪛 Markdownlint
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
170-194: Improved build target configuration instructionsThe instructions for configuring the build target are clear and well-illustrated with the new image. This addition will help users better understand the process.
There's a minor grammatical issue that could be improved:
-However, if you would like to add a target that is not available in the launch target drop-down, please follow the instructions below. +However, if you would like to add a target that is not available in the launch target drop-down, please follow the instructions below:🧰 Tools
🪛 LanguageTool
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode. 3. Select your application from the second drop-d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~193-~193: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unch Configuration` (Auto-detected). 4. Select a target from the third drop-down, whic...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Markdownlint
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
235-250: Improved project debugging instructionsThe instructions for debugging the project are clear and well-illustrated with the new image. The note about Windows driver installation is particularly helpful for Windows users.
There's a minor grammatical issue that could be improved:
-After creating the debug configuration, you can go ahead and debug the project. Select the configuration you just created, select debug mode, and click on the `Debug` icon  to start debugging: +After creating the debug configuration, you can go ahead and debug the project. Select the configuration you just created, select debug mode, and click on the `Debug` icon  to start debugging.🧰 Tools
🪛 LanguageTool
[uncategorized] ~243-~243: Possible missing comma found.
Context: ...ew for the new debug configuration will open where it's necessary to check the board...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
255-271: Clear instructions for creating a project using ESP-IDF templatesThe instructions for creating a new project using ESP-IDF templates are concise and easy to follow. The included image effectively illustrates the steps, enhancing user understanding of the process.
There's a minor typographical error that should be corrected:
-2. Go to `File` > `New` > `Espressif IDF Project` (If you don't see this, please reset the perspective from `Window` > `Perspective` > `Reset Perspective..`). +2. Go to `File` > `New` > `Espressif IDF Project` (If you don't see this, please reset the perspective from `Window` > `Perspective` > `Reset Perspective...`).🧰 Tools
🪛 LanguageTool
[typographical] ~258-~258: Two consecutive dots
Context: ...pective fromWindow>Perspective>Reset Perspective..). 3. Provide theProject name. 4. Cl...(DOUBLE_PUNCTUATION)
🪛 Markdownlint
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
336-346: Clear instructions for installing ESP-IDF ComponentsThe instructions for installing ESP-IDF Components are concise and easy to follow. The included images effectively illustrate the process, enhancing user understanding.
There's a minor grammatical issue that could be improved:
-* Right-click on the project from `Project Explorer` in which you want to add the component to and select `Install ESP-IDF Components`. +* Right-click on the project from `Project Explorer` in which you want to add the component, and select `Install ESP-IDF Components`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~336-~336: Possible missing comma found.
Context: ... in which you want to add the component to and selectInstall ESP-IDF Components...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~346-~346: Possible missing comma found.
Context: ... Already added components are also shown but theInstallbutton changes text to `A...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- README.md (29 hunks)
- README_CN.md (7 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~78-~78: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...Use_ESP-IDF.png) From the screen shown above you can either choose an already downlo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Possible missing article found.
Context: ...Finish, you will see the progress on console for the tools getting installed. Once t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~142-~142: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want, but only one of...(MANY_NN)
[grammar] ~142-~142: Did you mean “versions”?
Context: ...SP-IDF as you want, but only one of the version can be set active and that will be used...(CD_OF_THE_NN)
[grammar] ~144-~144: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ...workspace easily. Let's take a look at how the multiple versions will look like. You have to follow the same steps as d...(HOW_IT_SHOULD_BE)
[uncategorized] ~150-~150: Possible missing article found.
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...(AI_HYDRA_LEO_MISSING_THE)
[style] ~152-~152: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... made. > Note Please note that you can not delete an active ESP-IDF version. You n...(CAN_NOT_PREMIUM)
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode. 3. Select your application from the second drop-d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~193-~193: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unch Configuration` (Auto-detected). 4. Select a target from the third drop-down, whic...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~243-~243: Possible missing comma found.
Context: ...ew for the new debug configuration will open where it's necessary to check the board...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~258-~258: Two consecutive dots
Context: ...pective fromWindow>Perspective>Reset Perspective..). 3. Provide theProject name. 4. Cl...(DOUBLE_PUNCTUATION)
[uncategorized] ~336-~336: Possible missing comma found.
Context: ... in which you want to add the component to and selectInstall ESP-IDF Components...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~346-~346: Possible missing comma found.
Context: ... Already added components are also shown but theInstallbutton changes text to `A...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~402-~402: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...toolchain now is an experimental feature and you may face some build issues due to t...(COMMA_COMPOUND_SENTENCE)
[typographical] ~402-~402: Consider adding a comma here.
Context: ...irty). To work around clang build errors please refer to [this](https://github.com/espr...(PLEASE_COMMA)
[style] ~443-~443: Consider a more expressive alternative.
Context: ... you can still use the hints viewer. To do it, you have to manually download the `...(DO_ACHIEVE)
[style] ~444-~444: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...heRawbutton and thenSave as.... To open the hints viewer, go toWindows...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~449-~449: Did you mean “copy and paste”?
Context: ...-79af28c50c55.png) Now you can type or copy paste some error from the build log, for exam...(COPY_PASTE)
[uncategorized] ~563-~563: Possible missing comma found.
Context: ...an existing configuration with the same name then select `Overwrite existing launch ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~563-~563: ‘without warning’ might be wordy. Consider a shorter alternative.
Context: ...guration with the same name then selectOverwrite existing launch configurations without warning. 8. Click onFinish. <a name="gdbSt...(EN_WORDINESS_PREMIUM_WITHOUT_WARNING)
[uncategorized] ~605-~605: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ted. Remember that this is a panic mode and you can not continue the execution from...(COMMA_COMPOUND_SENTENCE)
[style] ~605-~605: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ember that this is a panic mode and you can not continue the execution from here, you w...(CAN_NOT_PREMIUM)
[uncategorized] ~609-~609: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...debug_panic_mode.png) You can view the registers stack trace and even view the value of ...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~629-~629: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ion in the core dump. You can view the registers stack trace and even view the value of ...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~691-~691: Loose punctuation mark.
Context: ...file://path/to/file``. *poll_period`: Data polling period (in ms) for availab...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~691-~691: Possible missing article found.
Context: ...ble trace data. If greater than 0, then command runs in non-blocking mode. By default, ...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~692-~692: Loose punctuation mark.
Context: ... mode. By default, 1 ms. *trace_size: Maximum size of data to collect (in byt...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~692-~692: Possible missing article found.
Context: ...ct (in bytes). Tracing is stopped after specified amount of data is received. By default ...(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~692-~692: Possible missing comma found.
Context: ...pecified amount of data is received. By default -1 (trace size stop trigger is disabled...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~693-~693: Loose punctuation mark.
Context: ...stop trigger is disabled). *stop_tmo: Idle timeout (in sec). Tracing is stopp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~694-~694: Loose punctuation mark.
Context: ...commands from the target. *wait4halt: If 0, start tracing immediately, otherw...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~762-~762: Possible missing comma found.
Context: ...binary (Chooseencryptto encrypt the binary and disable thegenerate keyoption t...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~775-~775: Possible missing comma found.
Context: ...ESP-IDF>Write Binary Data to Flash` command accessible by right click on the projec...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~775-~775: The verb “right-click” is spelled with a hyphen.
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...(CLICK_HYPHEN)
[style] ~783-~783: This phrase is redundant. Consider using “inside”.
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...(OUTSIDE_OF)
[style] ~808-~808: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en tick mark. 3. Click onDetails. 4. Click onSummaryon the left. 5. Scroll dow...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~818-~818: Possible missing comma found.
Context: ...onfigurationEditbutton from the top toolbar and this will launch the `Edit Configur...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~820-~820: Possible missing article found.
Context: ...tom build path>` with an absolute path. Customized build directory path could be within th...(AI_HYDRA_LEO_MISSING_THE)
README_CN.md
[uncategorized] ~130-~130: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：适当"地"可
Context: ...统路径中，则将预加载到以上界面中；如果没有，请点击浏览，在文件夹中选择适当的可执行文件。 3. 点击完成。该按钮将在所有路径和可执行文件得到正确配置...(wb4)
[uncategorized] ~148-~148: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...DF_Manager_Multiple_versions.png) 若想激活某一版本，请点击激活列中对应的单选按钮。 编辑器中中最后一列的刷新按钮可用于重...(wa5)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"启动
Context: ...sb-drivers)。 创建调试配置的最快方式是展开启动栏中的配置列表并点击新的启动配置...。然后选择ESP-IDF GDB OpenOCD 调试-...(wb4)
[uncategorized] ~243-~243: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"调试
Context: ...DF GDB OpenOCD 调试-> 双击或点击下一步`。接下来会打开新的调试配置预览页面，请仔细检查开发板的设置。 创建调试配置后就可以开始调试项目了...(wb4)
[uncategorized] ~533-~533: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"更新
Context: ...以按照以下步骤获取更新。 1. 前往帮助>检查更新。 2. 如有新的更新，请选择ESP-IDF Eclipse 插件，并取消勾选所有其他项目。...(wb4)
[uncategorized] ~803-~803: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"开发
Context: ...insUsingLocalFile">介绍进行安装。 # 如何获得最新的开发构建 1. 前往最新 master 分支，找到 <a href="http...(wb4)
🪛 Markdownlint
README.md
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
510-510: null
Bare URL used(MD034, no-bare-urls)
505-505: null
Images should have alternate text (alt text)(MD045, no-alt-text)
527-527: null
Bare URL used(MD034, no-bare-urls)
536-536: null
Images should have alternate text (alt text)(MD045, no-alt-text)
550-550: null
Images should have alternate text (alt text)(MD045, no-alt-text)
575-575: null
Images should have alternate text (alt text)(MD045, no-alt-text)
587-587: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
594-594: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
601-601: null
Images should have alternate text (alt text)(MD045, no-alt-text)
607-607: null
Images should have alternate text (alt text)(MD045, no-alt-text)
625-625: null
Images should have alternate text (alt text)(MD045, no-alt-text)
691-691: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
692-692: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
693-693: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
694-694: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
691-691: Column: 1
Hard tabs(MD010, no-hard-tabs)
692-692: Column: 1
Hard tabs(MD010, no-hard-tabs)
693-693: Column: 1
Hard tabs(MD010, no-hard-tabs)
694-694: Column: 1
Hard tabs(MD010, no-hard-tabs)
742-742: Column: 1
Hard tabs(MD010, no-hard-tabs)
743-743: Column: 1
Hard tabs(MD010, no-hard-tabs)
744-744: Column: 1
Hard tabs(MD010, no-hard-tabs)
745-745: Column: 1
Hard tabs(MD010, no-hard-tabs)
755-755: Column: 1
Hard tabs(MD010, no-hard-tabs)
760-760: Column: 1
Hard tabs(MD010, no-hard-tabs)
764-764: Column: 1
Hard tabs(MD010, no-hard-tabs)
766-766: Column: 1
Hard tabs(MD010, no-hard-tabs)
768-768: Column: 1
Hard tabs(MD010, no-hard-tabs)
741-741: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
843-843: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
844-844: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
845-845: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
846-846: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
README_CN.md
226-226: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
299-299: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
300-300: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
102-102: Column: 1
Hard tabs(MD010, no-hard-tabs)
103-103: Column: 1
Hard tabs(MD010, no-hard-tabs)
105-105: Column: 1
Hard tabs(MD010, no-hard-tabs)
296-296: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
362-362: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
378-378: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
80-80: null
Bare URL used(MD034, no-bare-urls)
104-104: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
110-110: null
Bare URL used(MD034, no-bare-urls)
309-309: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
313-313: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
109-109: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
245-245: null
Images should have alternate text (alt text)(MD045, no-alt-text)
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
289-289: null
Images should have alternate text (alt text)(MD045, no-alt-text)
293-293: null
Images should have alternate text (alt text)(MD045, no-alt-text)
311-311: null
Images should have alternate text (alt text)(MD045, no-alt-text)
315-315: null
Images should have alternate text (alt text)(MD045, no-alt-text)
329-329: null
Images should have alternate text (alt text)(MD045, no-alt-text)
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
353-353: null
Images should have alternate text (alt text)(MD045, no-alt-text)
375-375: null
Images should have alternate text (alt text)(MD045, no-alt-text)
389-389: null
Images should have alternate text (alt text)(MD045, no-alt-text)
638-638: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
639-639: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
508-508: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
539-539: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
510-510: null
Bare URL used(MD034, no-bare-urls)
527-527: null
Bare URL used(MD034, no-bare-urls)
587-587: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
594-594: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
467-467: null
Images should have alternate text (alt text)(MD045, no-alt-text)
475-475: null
Images should have alternate text (alt text)(MD045, no-alt-text)
489-489: null
Images should have alternate text (alt text)(MD045, no-alt-text)
505-505: null
Images should have alternate text (alt text)(MD045, no-alt-text)
518-518: null
Images should have alternate text (alt text)(MD045, no-alt-text)
536-536: null
Images should have alternate text (alt text)(MD045, no-alt-text)
550-550: null
Images should have alternate text (alt text)(MD045, no-alt-text)
575-575: null
Images should have alternate text (alt text)(MD045, no-alt-text)
579-579: null
Images should have alternate text (alt text)(MD045, no-alt-text)
601-601: null
Images should have alternate text (alt text)(MD045, no-alt-text)
607-607: null
Images should have alternate text (alt text)(MD045, no-alt-text)
625-625: null
Images should have alternate text (alt text)(MD045, no-alt-text)
654-654: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
655-655: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
656-656: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
690-690: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
691-691: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
692-692: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
693-693: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
694-694: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
695-695: Expected: 2; Actual: 1
Unordered list indentation(MD007, ul-indent)
654-654: Column: 1
Hard tabs(MD010, no-hard-tabs)
655-655: Column: 1
Hard tabs(MD010, no-hard-tabs)
656-656: Column: 1
Hard tabs(MD010, no-hard-tabs)
690-690: Column: 1
Hard tabs(MD010, no-hard-tabs)
691-691: Column: 1
Hard tabs(MD010, no-hard-tabs)
692-692: Column: 1
Hard tabs(MD010, no-hard-tabs)
693-693: Column: 1
Hard tabs(MD010, no-hard-tabs)
694-694: Column: 1
Hard tabs(MD010, no-hard-tabs)
695-695: Column: 1
Hard tabs(MD010, no-hard-tabs)
722-722: Column: 1
Hard tabs(MD010, no-hard-tabs)
724-724: Column: 1
Hard tabs(MD010, no-hard-tabs)
726-726: Column: 1
Hard tabs(MD010, no-hard-tabs)
742-742: Column: 1
Hard tabs(MD010, no-hard-tabs)
743-743: Column: 1
Hard tabs(MD010, no-hard-tabs)
744-744: Column: 1
Hard tabs(MD010, no-hard-tabs)
745-745: Column: 1
Hard tabs(MD010, no-hard-tabs)
755-755: Column: 1
Hard tabs(MD010, no-hard-tabs)
760-760: Column: 1
Hard tabs(MD010, no-hard-tabs)
764-764: Column: 1
Hard tabs(MD010, no-hard-tabs)
766-766: Column: 1
Hard tabs(MD010, no-hard-tabs)
768-768: Column: 1
Hard tabs(MD010, no-hard-tabs)
741-741: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
674-674: null
Images should have alternate text (alt text)(MD045, no-alt-text)
678-678: null
Images should have alternate text (alt text)(MD045, no-alt-text)
682-682: null
Images should have alternate text (alt text)(MD045, no-alt-text)
699-699: null
Images should have alternate text (alt text)(MD045, no-alt-text)
710-710: null
Images should have alternate text (alt text)(MD045, no-alt-text)
825-825: null
Images should have alternate text (alt text)(MD045, no-alt-text)
843-843: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
844-844: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
845-845: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
846-846: Expected: 5; Actual: 4; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
🔇 Additional comments (13)
README_CN.md (2)
Line range hint
5-18: Excellent updates to the introduction!The changes in this section significantly improve the README:
- The updated title "ESP-IDF Eclipse 插件 (Espressif-IDE)" provides better context.
- The new introduction paragraph clearly explains the plugin's purpose and benefits.
- The note about supported project types has been simplified and clarified.
These modifications enhance the document's clarity and user-friendliness.
117-152: Excellent ESP-IDF installation guideThis section provides a comprehensive guide for installing ESP-IDF:
- Step-by-step instructions are clear and easy to follow.
- Screenshots effectively illustrate the process.
- The guide covers adding and managing multiple ESP-IDF versions.
- Important notes about Python executable compatibility are included.
The explanation of how to activate different ESP-IDF versions is particularly useful for developers working with multiple projects or versions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~130-~130: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：适当"地"可
Context: ...统路径中，则将预加载到以上界面中；如果没有，请点击浏览，在文件夹中选择适当的可执行文件。 3. 点击完成。该按钮将在所有路径和可执行文件得到正确配置...(wb4)
[uncategorized] ~148-~148: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...DF_Manager_Multiple_versions.png) 若想激活某一版本，请点击激活列中对应的单选按钮。 编辑器中中最后一列的刷新按钮可用于重...(wa5)
🪛 Markdownlint
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
140-140: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
README.md (11)
8-9: Improved introduction and readabilityThe addition of a blank line and a new sentence enhances the document's structure and provides more comprehensive information about the plugin's capabilities.
26-33: Enhanced table of contentsThe updates to the table of contents improve navigation and readability. The consistent formatting and additional entries provide a more comprehensive overview of the document's structure.
87-90: Clear and specific prerequisitesThe updated prerequisites section now provides clear and specific version requirements for Java, Python, and Git. This information is crucial for users to ensure compatibility.
187-196: Clear and illustrated project compilation instructionsThe instructions for compiling the project are concise and easy to follow. The included image effectively illustrates the steps, enhancing user understanding of the process.
🧰 Tools
🪛 LanguageTool
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode. 3. Select your application from the second drop-d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~193-~193: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unch Configuration` (Auto-detected). 4. Select a target from the third drop-down, whic...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Markdownlint
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
199-208: Improved project flashing instructionsThe instructions for flashing the project are clear and well-illustrated with the new image. This addition will help users better understand the flashing process and the available options.
🧰 Tools
🪛 LanguageTool
[style] ~192-~192: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode. 3. Select your application from the second drop-d...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~193-~193: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...unch Configuration` (Auto-detected). 4. Select a target from the third drop-down, whic...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~202-~202: This word is normally spelled as one.
Context: ...s_readme/images/icons/run.png) and it's auto-configured to flash the application with the defau...(EN_COMPOUNDS_AUTO_CONFIGURED)
🪛 Markdownlint
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
184-184: null
Images should have alternate text (alt text)(MD045, no-alt-text)
194-194: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-196: null
Images should have alternate text (alt text)(MD045, no-alt-text)
202-202: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
211-232: Comprehensive instructions for viewing serial outputThe instructions for viewing serial output are clear, well-structured, and enhanced by the new image. The addition of ESP-IDF Serial Monitor Settings configuration instructions provides valuable information for users to customize their setup.
🧰 Tools
🪛 Markdownlint
224-224: null
Images should have alternate text (alt text)(MD045, no-alt-text)
271-284: Clear instructions for using the SDK Configuration EditorThe instructions for using the SDK Configuration Editor are concise and easy to follow. The included image effectively illustrates the editor interface, enhancing user understanding of the feature.
🧰 Tools
🪛 Markdownlint
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
287-294: Informative overview of the CMake EditorThe information provided about the CMake Editor is clear and concise. The included images effectively illustrate the editor interface and its preferences, giving users a good understanding of this feature.
🧰 Tools
🪛 LanguageTool
[typographical] ~258-~258: Two consecutive dots
Context: ...pective fromWindow>Perspective>Reset Perspective..). 3. Provide theProject name. 4. Cl...(DOUBLE_PUNCTUATION)
🪛 Markdownlint
267-267: null
Images should have alternate text (alt text)(MD045, no-alt-text)
282-282: null
Images should have alternate text (alt text)(MD045, no-alt-text)
289-289: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
297-315: Comprehensive overview of the ESP-IDF Application Size Analysis featureThe information provided about the ESP-IDF Application Size Analysis feature is comprehensive and well-structured. The included images effectively illustrate both the overview and details sections, giving users a clear understanding of this powerful analysis tool.
🧰 Tools
🪛 Markdownlint
309-309: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Line range hint
320-332: Clear instructions for using the ESP-IDF TerminalThe information provided about the ESP-IDF Terminal feature is concise and helpful. The instructions for launching the terminal are clear, and the included image effectively illustrates the terminal interface, enhancing user understanding of this feature.
Line range hint
351-355: Clear information on configuring environment variablesThe information provided about configuring environment variables is concise and helpful. The included image effectively illustrates the preferences page where users can verify the automatically configured variables, enhancing user understanding of this process.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~336-~336: Possible missing comma found.
Context: ... in which you want to add the component to and selectInstall ESP-IDF Components...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~346-~346: Possible missing comma found.
Context: ... Already added components are also shown but theInstallbutton changes text to `A...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint
338-338: null
Images should have alternate text (alt text)(MD045, no-alt-text)
344-344: null
Images should have alternate text (alt text)(MD045, no-alt-text)
353-353: null
Images should have alternate text (alt text)(MD045, no-alt-text)
|
Hi @NatashaLi-ESPRESSIF Plz help review the updated CN translation. Remind me if there should be other technical reviewers to be added. Thanks :) |
Can you pls add information about PRs that we can remove "need translation" labels after this PR is merged? |
Description
This PR:
Summary by CodeRabbit
READMEfiles.