Skip to content
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

Merged

Conversation

andrewbiang888
Copy link
Contributor

Add Installation section to readme to help the next person ❤️

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
Copy link
Member

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?

Copy link
Contributor Author

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:
Copy link
Member

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: ...`

Copy link
Contributor Author

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
Copy link
Member

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".

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
Copy link
Member

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:
Copy link
Member

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
```
Copy link
Member

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?

@sbc100 sbc100 merged commit 0583f0f into WebAssembly:main Nov 25, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants