search

DescentDevelopers / Descent3

Descent 3 by Outrage Entertainment
GNU General Public License v3.0
2.86k stars 247 forks source link

There should only be one list of command-line options #618

Open Jayman2000 opened 5 days ago

Jayman2000 commented 5 days ago

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.

winterheart commented 5 days ago

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

Lgt2x commented 5 days ago

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.