Telemachus

Telemachus

14.7k Downloads

[wiki] Suggestion: Change wording of Building guide to clarify "KSP game files"

fixermark opened this issue ยท 2 comments

commented

Recommendation: In the wiki page https://github.com/richardbunt/Telemachus/wiki/Building

Change this line:
Create a directory called "ksp-telemachus-dev" in the freshly cloned repository, then copy the KSP game files into this newly created directory.

... to...

Create a directory called "ksp-telemachus-dev" in the freshly cloned repository, then copy the KSP game files into this newly created directory. If you've done this correctly, there should now be a "ksp-telemachus-dev\KSP_Data" directory.

Explanation: The "Getting started" directions at http://wiki.kerbalspaceprogram.com/wiki/Setting_up_Visual_Studio recommend linking to the relevant DLLs instead of copying the game data. That solution isn't very portable at all. The solution your wiki provides is a better solution for portable code building, but users familiar with the getting started directions may think that by "KSP game files", the contents of only the KSP_Data directory is meant (as this is the only directory needed). Clarifying what the result of the copy operation should look like might clean up misunderstanding.

commented

I have updated the wiki page based upon your suggestion.

commented

Looks great! Thank you. :)