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

Hello World instructions unclear. #126

Closed
cldershem opened this issue Apr 13, 2018 · 2 comments
Closed

Hello World instructions unclear. #126

cldershem opened this issue Apr 13, 2018 · 2 comments
Labels

Comments

@cldershem
Copy link

There are a few pieces in the Hello World chapter that are not as clear as they could be.

  1. code snippets include optional dependency
  2. Instructions on serving the wasm file are confusing.

1 - The file name referred to in the html/script is hello_world.gc.opt.wasm which is only the name of the file if you've chosen to 'make the binary even smaller'. Because this is an optional step, one may not take it, especially if they're just trying to experiment quickly or getting a working setup. A simple fix would be to not name the file differently during the optional step.

2 - There are two ways to serve the wasm file, one using the https crate (or a webserver one may have already installed on the machine) and another using the Python3 simple server. However the instructions in the Note say there is a stipulation on the webservers that may be used. The majority of users checking this out for the first time will likely be on a machine without a real webserver installed. The Python3 server is used fairly ubiquitously in example code throughout the web, so I think it might be a good idea to list this first.

It is confusing to include both example in a Hello World section. I think it might benefit users to only include one, either require the https crate to be used (which is a reasonable dependency) or only list the Python3 example with a note of the caveat and that there is a potentially better way to do it when the user gets to the real world.

@ablwr
Copy link

ablwr commented Apr 23, 2018

Oh yes, this tripped me up too, because I skipped the optional step! Although a good lesson in debugging and reading the things that I paste from the internet into my terminal, I agree that it is a bit unclear.

@jrichocean
Copy link

This issue has been moved here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants