WebAssembly / wabt

The WebAssembly Binary Toolkit
Apache License 2.0
6.74k stars 688 forks source link

Missing instructions for the provided binary archives #1420

Open TheDet opened 4 years ago

TheDet commented 4 years ago

On one hand there is the Readme.md providing information for cloning and building the suite manually. On the other hand there are binaries packed in archives for different platforms provided on the 'releases' tab, which is very helpful for beginners.

What I am missing though, are instructions for what to do after unpacking the binary archives.

E.g. the wabt-1.0.15-linux.tar.gz : Extracting it gives a bunch of bin files ... is there a special target folder to copy them into? What about the .asm files are they meant to be copied somewhere too?

(Note: There is for example the 'Programming WebAssembly with Rust' book which starts with wabt as WebAssembly introduction, but more or less "assumes" the binaries to be in /usr/local/bin).

binji commented 4 years ago

Good point, this should be clarified. But to answer your question, the executables don't depend on anything else, so you should be able to unpack them anywhere convenient.

The .wasm files probably shouldn't be included in the releases at all -- I didn't realize we were packaging those. @sbc100 it looks like the c-api exes and resources are getting included here, is there an easy way to exclude them from releases?

sbc100 commented 4 years ago

Yeah, we shouldn't be including them. I guess we should disable those targets in the release builders (maybe even disable all testing? we also don't want to ship the unittest binary right?)

binji commented 4 years ago

We could do that, but I don't think we have a separate release builder. I guess it could be a different configuration though?