docs(compiler): explain compilerPath argument and related fixes

[davidyuk]

This PR is supported by the Æternity Crypto Foundation

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (5c84671) 81.37% compared to head (d81129e) 81.37%.
Report is 14 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1870   +/-   ##
========================================
  Coverage    81.37%   81.37%           
========================================
  Files           94       94           
  Lines         3361     3361           
  Branches       671      671           
========================================
  Hits          2735     2735           
  Misses         303      303           
  Partials       323      323           

Files Changed	Coverage Δ
src/Middleware.ts	67.64% <ø> (ø)
src/Node.ts	91.66% <ø> (ø)
src/aepp-wallet-communication/rpc/types.ts	100.00% <ø> (ø)
src/aepp-wallet-communication/wallet-detector.ts	26.31% <0.00%> (ø)
src/contract/compiler/Cli.ts	83.78% <ø> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[marc0olo]

"integrated one" means that the CLI is actually shipped along with the SDK. do I understand correctly? I think it should be made clear to the reader that this is actually the case. I didn't know that 😅

[marc0olo]

I assume that windows is not supported here using the CLI compiler, right? 🤔

[davidyuk]

do I understand correctly?

Yep.

I've checked it before, it should be working in windows.

[marc0olo]

that's cool. wouldn't have expected the CLI binary of the compiler to work with windows

[davidyuk]

it is an Erlang VM binary as I understand

[marc0olo]

it would also be great to have this explained in the contract guide here:

• https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/contracts.md

few things I would love to see added/adjusted:

1. explain the difference between CLI compiler and http compiler
   • also, provide a note that the "hosted" compiler will be decommissioned and tell the user to run their own local http compiler if needed or to install the erlang dependency to use the shipped CLI
   • also provide a note that windows doesn't support the CLI compiler (if that's the case)
2. show usage of compiler methods directly that show how to:
   • generate & use bytecode & ACI (seems currently missing)
3. refer to or explain the utility method to get the filesystem map