Highlight lcov support in the readme #1081
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update README.md
|
|
arcz
requested changes
Jun 21, 2023
Member
arcz
left a comment
arcz
left a comment
There was a problem hiding this comment.
I'm sorry, but this looks AI-generated. Did you get this from ChatGPT? It is not only overly verbose, but the instructions are also wrong.
| 1. Install Echidna globally by running the following command in your terminal or command prompt: | ||
|
|
||
| ```shell | ||
| npm install -g echidna |
| 2. Once Echidna is installed, execute the following command to run Echidna with coverage enabled: | ||
|
|
||
| ```shell | ||
| echidna --coverage |
|
|
||
| #### Run Echidna and generate a coverage report | ||
|
|
||
| Echidna is a powerful fuzz testing tool used to discover bugs in smart contracts. Before running Echidna, ensure that you have the following prerequisites installed: |
Member
There was a problem hiding this comment.
there is no need to explain what Echidna is here
Collaborator
|
Superseded by #1093 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request addresses issue #1063 and enhances the documentation for the Echidna tool by adding instructions on how to leverage the lcov support with a VSCode plugin. The updated documentation provides clear and beginner-friendly steps to install the lcov plugin, generate coverage reports, open the reports in VSCode, and utilize the lcov plugin to visualize the coverage of smart contracts.
Changes Made
How to Test
Related Issues
Closes #1063
Please let me know if there are any further modifications or additions required. I'm happy to assist!