-
Notifications
You must be signed in to change notification settings - Fork 720
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add installation section to README.md #2514
add installation section to README.md #2514
Conversation
README.md
Outdated
@@ -26,6 +26,20 @@ tools do not aim to provide an optimization platform or a higher-level compiler | |||
target; instead they aim for full fidelity and compliance with the spec (e.g. | |||
1:1 round-trips with no changes to instructions). | |||
|
|||
## Installation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you move this down the end, and perhaps call it Installing prebuilt binaries
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! 8ef4cea
README.md
Outdated
@@ -26,6 +26,20 @@ tools do not aim to provide an optimization platform or a higher-level compiler | |||
target; instead they aim for full fidelity and compliance with the spec (e.g. | |||
1:1 round-trips with no changes to instructions). | |||
|
|||
## Installation | |||
You can install Wabt command line tools on Linux or macOS using Homebrew: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: ...`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copy updated 8ef4cea
README.md
Outdated
```sh | ||
sudo apt install wabt | ||
``` | ||
Windows or otherwise interested users can download installers and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You about: "You can also download prebuilt binaryes for many platforms directly from the github releases page".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you
README.md
Outdated
@@ -26,6 +26,20 @@ tools do not aim to provide an optimization platform or a higher-level compiler | |||
target; instead they aim for full fidelity and compliance with the spec (e.g. | |||
1:1 round-trips with no changes to instructions). | |||
|
|||
## Installation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add empty newline after this title.
README.md
Outdated
|
||
## Installing prebuilt binaries | ||
|
||
Wabt is available on many platforms as prepackaged binaries. For example if you use Homebrew you can use: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a comma after "For example" , and wrap this line at 80 columns (same with the very last line)
And you use an apt-based linux distribution you can use: | ||
```sh | ||
sudo apt install wabt | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe an empty line here?
Add
Installation
section to readme to help the next person ❤️