docs: add libevm/README.md documentation #175
Open
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
….md to libevm/README.md
darioush
approved these changes
Apr 3, 2025
ARR4N
reviewed
Apr 3, 2025
| with: | ||
| globs: | | ||
| libevm/**.md | ||
| config: .github/workflows/configs/.markdownlint.json |
There was a problem hiding this comment.
Suggested change
| config: .github/workflows/configs/.markdownlint.json | |
| config: .github/workflows/configs/markdownlint.json |
This is already in the hidden .github directory so no point hiding the file too.
There was a problem hiding this comment.
Actually the only point is to have it match the file icon and json schema, given the default markdown lint config file name is .markdownlint.json. But I can remove the leading dot if you feel it's important
| @@ -0,0 +1,3 @@ | |||
| { | |||
| "MD013": false | |||
| } | |||
There was a problem hiding this comment.
Add a new line at the end of the file.
There was a problem hiding this comment.
That's my JSON auto-formatter, it does remove trailing new lines for json files 😄
libevm/README.md
Outdated
There was a problem hiding this comment.
(fyi) I haven't reviewed this file yet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why this should be merged
Documentation for the libevm repository was lacking and requested, so here it is.
This consists of moving all libevm-related documentation in
libevm/README.md.Now the root
README.mdonly has a reference tolibevm/README.mdto reduce diffs even more with geth code.This new readme, on top of taking existing documentation from the root readme, explains the following:
How this works
How this was tested