add installation section to README.md #2514
Merged
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
sbc100
reviewed
Nov 24, 2024
README.md
Outdated
| target; instead they aim for full fidelity and compliance with the spec (e.g. | ||
| 1:1 round-trips with no changes to instructions). | ||
|
|
||
| ## Installation |
Member
There was a problem hiding this comment.
Can you move this down the end, and perhaps call it Installing prebuilt binaries?
README.md
Outdated
| 1:1 round-trips with no changes to instructions). | ||
|
|
||
| ## Installation | ||
| You can install Wabt command line tools on Linux or macOS using Homebrew: |
Member
There was a problem hiding this comment.
How about something like: "wabt is available on many plafforms as prepackaged binaries. For example if you use Homebrew you can use: .... And you use an apt-based linux distribution you can use: ...`
README.md
Outdated
| ```sh | ||
| sudo apt install wabt | ||
| ``` | ||
| Windows or otherwise interested users can download installers and |
Member
There was a problem hiding this comment.
You about: "You can also download prebuilt binaryes for many platforms directly from the github releases page".
README.md
Outdated
| target; instead they aim for full fidelity and compliance with the spec (e.g. | ||
| 1:1 round-trips with no changes to instructions). | ||
|
|
||
| ## Installation |
Member
There was a problem hiding this comment.
Add empty newline after this title.
sbc100
reviewed
Nov 24, 2024
README.md
Outdated
|
|
||
| ## Installing prebuilt binaries | ||
|
|
||
| Wabt is available on many platforms as prepackaged binaries. For example if you use Homebrew you can use: |
Member
There was a problem hiding this comment.
Can you add a comma after "For example" , and wrap this line at 80 columns (same with the very last line)
sbc100
reviewed
Nov 24, 2024
| And you use an apt-based linux distribution you can use: | ||
| ```sh | ||
| sudo apt install wabt | ||
| ``` |
sbc100
approved these changes
Nov 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Add
Installationsection to readme to help the next person ❤️