adawebpack icon indicating copy to clipboard operation
adawebpack copied to clipboard

Documentation requests: GNAT, wasm-ld, and an http server

Open johnperry-math opened this issue 2 years ago • 0 comments

It works! Some suggestions on improving the documentation:

Update "How to install" with...

Tell users they need

  • a recent version of GNAT, in order to have access to gprbuild
  • wasm-ld, which can be obtained:
    • on Fedora Linux through the lld package,
    • on Ubuntu through the lld-13 package (I think),
    • on other systems through... (GNAT might be obvious, but wasm-ld won't be obvious until it fails.)

Update "Now you can build examples" with...

Tell users they probably need to run the examples through an HTTP server; they cannot just load them them as HTML files. An http server is easily obtained by running python3 -m http.server (if one has Python3 installed) or ...

This second item has dogged me from time to time. I do web development very rarely, so I forget that modern web browsers don't allow one to load a script from a local filesystem unless one goes through a web server.

Perhaps include images of expected output.

I watched @reznikmm 's presentation at FOSDEM and he showed a rotating cube that one could manipulate. It was great! but... the WebGL demo included here was a bit of a disappointment after that.

Actually, am I seeing the right thing? All I see is a white box on a black background. I could inspect the Ada code, but perhaps it would be nice to include a screenshot in the documentation, so that new users know what to expect?

johnperry-math avatar Feb 13 '22 06:02 johnperry-math