Make Structure of README's more Consistent and Fix Dead Link #507
Conversation
This file contains 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
jtraglia
reviewed
Sep 12, 2024
README.md
Outdated
Comment on lines
14
to
18
| For all bindings, you first need to make sure that the `blst` submodule is correctly pulled after clone. | ||
| To do so, you may need to run: | ||
|
|
||
| ``` | ||
| git submodule update --init |
There was a problem hiding this comment.
Hmm we should try to fix the Makefiles so this isn't necessary. We can do something like this:
$(MAKE) -C ../../src blst
There was a problem hiding this comment.
Will remove this comment and we can open another PR for fixing the Makefiles. :)
jtraglia
reviewed
Sep 12, 2024
README.md
Outdated
Comment on lines
19
to
22
| ``` | ||
|
|
||
|
|
||
| | Language | Link | |
There was a problem hiding this comment.
I believe a single blank line between paragraphs/sections is most common in this repo.
jtraglia
reviewed
Sep 12, 2024
bindings/java/README.md
Outdated
Comment on lines
28
to
31
| ## Public Maven Repo | ||
|
|
||
| The library which uses this binding and publishes a package to a public maven repo | ||
| is [jc-kzg-4844](https://github.com/ConsenSys/jc-kzg-4844). |
There was a problem hiding this comment.
This reminds me, we should add this link to the readme too:
https://central.sonatype.com/artifact/io.consensys.protocols/jc-kzg-4844
jtraglia
reviewed
Sep 12, 2024
bindings/nim/README.md
Outdated
Comment on lines
20
to
23
| ``` | ||
|
|
||
|
|
||
| ## Tests |
jtraglia
reviewed
Sep 12, 2024
bindings/nim/README.md
Outdated
Comment on lines
15
to
16
| ## Installation | ||
| Install via nimble: |
jtraglia
reviewed
Sep 12, 2024
b-wagn
changed the title
b-wagn
changed the title
jtraglia
approved these changes
Sep 12, 2024
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.
This PR does two things related to README files:
I think for 2, we can improve it more in the future. For now, I mostly made sure all files have consistent headings and a consistent first sentence, as well as a Prerequisites section.
Happy about feedback how to improve it even more.