archives/freedoom
2
0
Fork 0
mirror of https://github.com/freedoom/freedoom.git synced 2025-08-31 20:16:55 -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

26
COMPILING.adoc
View file

@ -1,9 +1,9 @@
Compiling Freedoom
==================
This document is a general overview of Freedoom's dependencies
This document is a general overview of Freedoom’s dependencies
required to build it. See `README` for a description of what Freedoom
'is', and `BUILD-SYSTEM` for the technical details on 'how' Freedoom
_is_, and `BUILD-SYSTEM` for the technical details on _how_ Freedoom
is built.
Required software
@ -11,26 +11,24 @@ Required software
Building the Freedoom IWADs pretty much simply requires the following:
* 'make': While there is some attempt to keep our Makefiles
* _make_: While there is some attempt to keep our Makefiles
portable, testing does not really happen on anything but
https://www.gnu.org/software/make/[GNU Make] (patches to fix
portability are most welcome!). On non-GNU systems, it might be
available in a package and binary named as 'gmake'.
* 'Python': Freedoom uses several Python programs in its tree to
available in a package and binary named as _gmake_.
* _Python_: Freedoom uses several Python programs in its tree to
assist with building the IWADs. Both Python 2.7 and 3.x are fully
supported.
* 'Pillow': A Python image manipulation module that provides the
* _Pillow_: A Python image manipulation module that provides the
features we need for scaling and composing various graphics of the
game.
* 'DeuTex' 5.0: Freedoom depends on features developed in this
* _DeuTex_ 5.0: Freedoom depends on features developed in this
version of DeuTex and will not build on earlier versions. It is
available at https://github.com/Doom-Utils/deutex in source and
Windows binary formats. As of July 2017, this version is very
recent and may not be widely available in Unix distribution
repositories yet.
Windows binary formats.
All or most of this software should already be available in your
operating system's software repository, with the likely exception of
operating system’s software repository, with the likely exception of
DeuTex, which is easy to build.
Building Freedoom
@ -69,14 +67,14 @@ this document.
Optional software
-----------------
* 'Git': Freedoom is developed using the Git version control system,
* _Git_: Freedoom is developed using the Git version control system,
the latest developments can be tracked with it.
* 'AsciiDoc': The `*.adoc` files are all written in AsciiDoc markup,
* _AsciiDoc_: The `*.adoc` files are all written in AsciiDoc markup,
and it can be used to generate HTML versions of all these
documents. This is used as part of the `make dist` target, to
generate the `README.html` file for inclusion with official Zip
files.
* 'Zip': The `make dist` target uses Zip to create release archives
* _Zip_: The `make dist` target uses Zip to create release archives
for FreeDM, Phase 1, and Phase 2. This can also provide an easy
way to automate generating in-development versions for other
people.