archives/freedoom
2
0
Fork 0
mirror of https://github.com/freedoom/freedoom.git synced 2025-09-04 22:25:47 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

documentation: change ascii ' quotes to either ’ or _

Browse source 
Non-reference AsciiDoc implementations such as AsciiDoctor (used by
GitHub) or even the simplistic parser in loccount choke up on these
characters for different reasons.  AsciiDoctor doesn’t seem to even
parse them, displaying them as-is and not with emphasized text.
loccount would get hung up on possessives, expecting a terminating
character for emphasis that never comes.

Annoying, but easy to work around.  the curly ’ character can be used
for possessives and _underscores_ can be used for emphasis.
This commit is contained in:
Mike Swanson 2019-08-25 21:17:41 -07:00
parent 4ccdc785d0
commit 3b0f55db25
5 changed files with 35 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

4
dist/freedoom vendored
View file

@ -8,7 +8,7 @@ PORTS="doom odamex crispy-doom prboom-plus eternity gzdoom chocolate-doom"
# Just a single argument starting the command is allowed, -p, in order
# to explicitly set a port on the command line. -- is also supported
# so that -p can be instead sent directly to the port's argument list.
# so that -p can be instead sent directly to the port’s argument list.
if [ $# -gt 0 ]; then
if [ "$1" = "-p" ]; then
@ -54,7 +54,7 @@ for port in $PORTS; do
done
done
# If we've reached this far, no engine was successfully executed.
# If we’ve reached this far, no engine was successfully executed.
# print message to stderr and exit with a status of 1.
cat <<EOF >&2

14
dist/freedoom.adoc vendored
View file

@ -8,30 +8,30 @@ freedoom - Automatically launch Freedoom with an engine
SYNOPSIS
--------
*freedoom* ['-p' 'PORT'|'--'] ['ARGS']
*freedoom* [_-p_ _PORT_|_--_] [_ARGS_]
DESCRIPTION
-----------
Freedoom is a project to create a complete free-content game based on
the 'Doom' engine (often called “source ports” or simply “ports”),
the _Doom_ engine (often called “source ports” or simply “ports”),
which itself is free software. In addition, it maintains
compatibility with 'Doom' itself and is capable of playing the wide
compatibility with _Doom_ itself and is capable of playing the wide
variety of modifications (“mods”) that have been released by an
active community since 1993.
This command is a simple shell script to assist in running Freedoom,
which is not a game engine itself nor part of any engine project, but
playing Freedoom should remain simple. Only accepted as the first
argument, you may pass '-p PORT', which will run Freedoom using the
'PORT' specified. As an alternative, you may make a symbolic link
argument, you may pass _-p PORT_, which will run Freedoom using the
_PORT_ specified. As an alternative, you may make a symbolic link
named +$HOME/.doomport+ to your preferred port. A port specified on
the command line explicitly overrides +$HOME/.doomport+, whereas the
existence of the symbolic link will override the detection of port
based on a hard-coded list.
Additional arguments passed to the program, or after specifying '--'
Additional arguments passed to the program, or after specifying _--_
as the first option, will be passed to the engine being called. This
can allow you to use options such as '-file' to load mods or anything
can allow you to use options such as _-file_ to load mods or anything
else available with the engine of choice.
COPYRIGHT