aptos-core icon indicating copy to clipboard operation
aptos-core copied to clipboard

[docs] Add dependency instructions for from source for Windows

Open gregnazario opened this issue 3 years ago • 1 comments

Description

Test Plan

TBD need to see the test site


This change is Reviewable

gregnazario avatar Oct 17 '22 07:10 gregnazario

gotta resurrect this!

davidiw avatar Nov 05 '22 20:11 davidiw

@gregnazario , let's update this.

davidiw avatar Dec 03 '22 21:12 davidiw

Please! Give someone a Christmas gift.

davidiw avatar Dec 18 '22 04:12 davidiw

I'm looking into this right now. I had to spin up a Windows VM for it, and dealing with instructions for line endings etc.

gregnazario avatar Dec 21 '22 22:12 gregnazario

Hi Greg,

This generally looks good with a few small edits I made directly. I have two concerns and have included Sherry along with David for guidance:

  1. Why make source use for advanced users?
  2. Are the lists of packages for manual install complete? I recall the script installing more.

Thanks for the improvements!

  1. We could make source use for all users. Though, it can become very confusing. For example, one of the dependencies I had to install was LLVM. LLVM doesn't provide packaged support for Windows, so you have to check out the source, compile it, ensure you're choosing the right options etc. It's not that it's that bad, but the default compilation mode is slower at runtime (debug mode), and the time it takes to compile the codebase on a older machine / doesn't have the memory (if not Linux with LLD), can be very daunting & frustrating.
  2. The lists of the package aren't necessarily complete, but that should support most use cases. It's a pretty long list of mostly optional dependencies (at least for Windows). For example, Python / typescript aren't needed unless you work with the SDKs directly

gregnazario avatar Dec 22 '22 16:12 gregnazario