Commit Graph

17 Commits

Author SHA1 Message Date
Jason Yundt
d45576cb8a Convert table of command-line options into list
Before this change, USAGE.md had an HTML table that contained
documentation for all of Descent 3’s command-line options. A concern was
raised that an HTML table might not be easy to read if someone
downloaded Descent 3 and opened USAGE.md in a plain text editor [1].
This commit alleviates that concern by converting the HTML table into
bulleted lists. Credit for this idea goes to @Lgt2x [2].

The main motivation behind this change is to help get #623 merged.

[1]: <https://github.com/DescentDevelopers/Descent3/pull/623#discussion_r1790331994>
[2]: <https://github.com/DescentDevelopers/Descent3/pull/623#discussion_r1790741430>
2024-12-23 14:06:39 -05:00
Jason Yundt
5708b79c10 Document -additionaldir 2024-12-23 13:56:53 -05:00
Jason Yundt
db87580baa Remove docs for CLI options that no longer exist 2024-12-23 13:56:53 -05:00
Jason Yundt
213df11ba6 Replace main.exe reference with Descent3.exe reference
Before this change, USAGE.md talked about “main.exe”. In Descent 3
v1.4.0, there was indeed an executable named MAIN.EXE. However, that
executable was renamed to Descent3.exe in v1.5.0.
2024-12-23 13:56:53 -05:00
Jason Yundt
0d4b8cfda7 Fix formatting of code in CLI option description
Before this change, the documentation for -logfile did not format its
code spans correctly. Specifically, it used back ticks to create code
spans. Unfortunately, you can’t create code spans using back ticks if
the code spans are embedded in an HTML block. This change fixes the
formatting by replacing the back ticks with <code> and </code>.
2024-12-23 13:56:53 -05:00
Jason Yundt
ab384e97d5 Import wiki’s CLI docs into USAGE.md
This commit takes all of the command-line options documentation from the
wiki [1] and merges it with the command-line options documentation
that’s in USAGE.md. This change will eventually allow us to remove the
command-line options documentation from the wiki so that we only have
one list of command-line options instead of two.

Before this change, USAGE.md used a Markdown table and the wiki used an
HTML table. I ended up replacing the Markdown table in USAGE.md with an
HTML table because it was easier to copy and paste the HTML table from
the wiki than to convert the HTML table from the wiki into a Markdown
table.

The main motivation behind this change is to make it easier to create a
future commit. That future commit will add documentation for the
-additionaldir command-line option. Making sure that there’s only one
list of command-line options instead of two will make it so that
-additionaldir doesn’t need to be documented in two different places.

This is related #618, but it doesn’t fully fix that issue.

[1]: <https://github.com/DescentDevelopers/Descent3/wiki/Running-Descent-3#command-line-options>
2024-12-23 13:56:49 -05:00
Jason Yundt
74a18aed51 Add missing <placeholder> for -display
Before this change, the documentation for the command-line options that
take arguments was inconsistent. There was a <placeholder> in the
“option” cell for almost all of the command-line options that take
arguments. -display was the only command-line option that takes
arguments that didn’t have a <placeholder>. This change makes the
documentation more consistent by ensuring that all command-line options
that take arguments have <placeholders>.
2024-12-23 13:43:40 -05:00
Jason Yundt
d85e0b606f Fix description of -dedicated
Before this change, USAGE.md said that -dedicated was a boolean option
and that it took 0 arguments. This is not correct, and it contradicts
the wiki’s documentation for -dedicated [1]. This commit fixes that
issue.

[1]: <https://github.com/DescentDevelopers/Descent3/wiki/Running-Descent-3#command-line-options>
2024-12-23 12:49:50 -05:00
Sebastian Holtermann
bc12e2bf9f Add documentation for the -display command line argument in USAGE.md 2024-12-17 20:53:55 +01:00
Nate Eagleson
ec07a53d45
fix typo in USAGE.md 2024-12-14 01:51:44 -05:00
Azamat H. Hackimov
7fe52ecb97
Merge pull request #642 from Lgt2x/arm64-cross
Introduce cross-compiled ARM64 build
2024-11-29 16:15:01 +03:00
Louis Gombert
78c1e61a27 Fix USAGE.md instructions with updated file locations 2024-11-25 22:44:37 +01:00
halprin
d26cedf8c2
Add macOS step to xattr the netgames folder 2024-11-10 09:07:33 -07:00
Azamat H. Hackimov
72e8347fe1 Move Descent3 built targets into "${CMAKE_BINARY_DIR}/build" directory
This solves problem of inability determine generated output directory of libraries targets. Now `add_custom_command()`, used on HOG generation, correctly locates all needed paths and not depends on generated variables.
2024-10-27 22:04:00 +03:00
Azamat H. Hackimov
c6ab519652 Add plog library as logging facility
Added additional cmake option `USE_SYSTEM_PLOG`.
2024-09-10 03:00:23 +03:00
Chris Sarbora
3c406beb16
Add xattr command to OS X usage instructions 2024-09-02 00:08:53 -07:00
Louis Gombert
164f102368 Split README between README, BUILD and USAGE files.
Prepare those files to be shipped with the pre-built assets.
2024-08-15 01:02:10 +02:00