Documentation files about sod-to-bg2ee-item-upgrade

[mike1072]

The .md files are not included in the official download packages. Make sure you are downloading one of the packages from the latest release rather than the source code or master branch.

[RoxanneSHS]

They should be included, that is the point to have them in a subfolder.

[mike1072]

They are converted to .html files which ARE included.

[RoxanneSHS]

Right, but only if you use the self-installing exe from the the release. If you use the zip-file, then no.
Anyway, it was intended as a suggestion for improvement, so never mind.

[mike1072]

The HTML files are present in the Windows .exe, MacOS .zip, and Linux .zip releases.

The idea is that players should not be downloading the source code directly. At G3, we've always advised players to download the appropriate package for their operating system, for several reasons:

• The packages contain only the files needed for installation (no unnecessary .gitignore, package_mod.bat, .md files, or utilities for other operating systems)
• The packages include a copy of WeiDU for the appropriate OS so the mod can be installed easily

The Markdown-to-HTML conversion is something new we're trying out, so that we can maintain the mod documentation in a single format and have it easily viewable both on GitHub and with the files included in the mod download.

It's still a work-in-progress, so if you have any other suggestions, feel free to direct them to the topic at G3.