dfhack
dfhack copied to clipboard
DFHack
[WIP] Improvements to Windows compile docs?
The FAQ could use some massaging [suggestions/change-requests welcome]
resolves #2205 ?
These look good to me.
Sorry, at least one more change to take a look at. Maybe another, not sure. I'n thinking about the fat collected in/around the command line section, maybe finding some short/simple instructions to replace some of it with.. I'm not 100% keen on testing the command line environments for a path with sure footing though.. so maybe not.
The command line improvements can wait for a second PR I think. It'll probably take me a long time to try out and weigh the options before I can pick one to provide a proper guide of.
Still open to suggestions and/or change-requests, but otherwise nothing it stopping someone from merging.
Trying the Windows compile docs for the first time right now. I was confused by the following:
For ABI compatibility with recent releases of Dwarf Fortress, DFHack requires the v140 or v140_xp toolchain to build windows. You’ll need v140_xp if you want to build 32-bit. These instructions will help you obtain v140_xp so you can build both architectures.
This made me think that I should use v140, because I have a 64 bit machine (as most users do). I thought I would not need to "build both architectures". Only later in the docs I found out that v140_xp is the standard and should be advised here.
Also, the multiple generate batch files are confusing. It might be better if we remove the all one (which requires more dependencies than we have documented as required, like sphinx), and leave just minimal and gui. We should also specifically promote minimal as the script to run unless the developer has specific requirements, then they should run gui
I think just promoting minimal is sufficient. Having a script that "builds everything" is useful to some people, and I feel like people who don't want to install extra dependencies would opt for the one named "minimal".
