Descent3 icon indicating copy to clipboard operation
Descent3 copied to clipboard

There should only be one list of command-line options

Open Jayman2000 opened this issue 1 year ago • 2 comments

At the moment, both USAGE.md and the wiki have lists of command-line options for Descent 3. It would be better if there was just one list instead of two.

In the PR description for #471, I said that I would open a pull request that adds documentation for -additionaldir if #471 got merged. Now that #471 has been merged, it’s not clear to me if I should add the documentation to USAGE.md , the wiki or both. If there was only one list of command-line options, then it would be clear where documentation for new command-line options should go.

Jayman2000 avatar Oct 05 '24 19:10 Jayman2000

USAGE.md is main doc for users, cmd-line options included. New documentation related to user interaction should be reflected in USAGE.md.

winterheart avatar Oct 05 '24 22:10 winterheart

The wiki lists the command-line options available when the project started. Since then, several have been removed and added. The source of truth should be USAGE.md, and the wiki should be used for developer docs.

It could be its own issue, but the game itself should know what options it supports and be able to display a help menu when launched with --help/-h.

Lgt2x avatar Oct 06 '24 09:10 Lgt2x

This issue was fixed when the patch from #624 was accepted.

Jayman2000 avatar Jan 06 '25 14:01 Jayman2000