Skip to content

Commit 2a69288

Browse files
authored
Update README.rst
1 parent 1abf091 commit 2a69288

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.rst

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,31 @@ Install the `MacTeX distribution <http://tug.org/mactex/>`_.
2424
If you are on a slow network, you'll want to get the `BasicTeX package <http://tug.org/mactex/morepackages.html>`_ instead,
2525
then run the following command to install the other packages that the draft requires:
2626

27-
sudo tlmgr install latexmk isodate substr relsize ulem fixme rsfs extract layouts enumitem l3packages l3kernel imakeidx splitindex xstring
27+
``sudo tlmgr install latexmk isodate substr relsize ulem fixme rsfs extract layouts enumitem l3packages l3kernel imakeidx splitindex xstring``
2828

2929
---------------------------------------
3030
Getting Started on Debian-based Systems
3131
---------------------------------------
3232

3333
Install the following packages:
3434

35-
sudo apt-get install latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended lmodern
35+
``sudo apt-get install latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended lmodern``
3636

3737
-------------------------
3838
Getting Started on Fedora
3939
-------------------------
4040

4141
Install the following packages:
4242

43-
dnf install latexmk texlive texlive-isodate texlive-relsize texlive-ulem texlive-fixme texlive-extract texlive-l3kernel texlive-l3packages texlive-splitindex texlive-imakeidx
43+
``dnf install latexmk texlive texlive-isodate texlive-relsize texlive-ulem texlive-fixme texlive-extract texlive-l3kernel texlive-l3packages texlive-splitindex texlive-imakeidx``
4444

4545
-----------------------------
4646
Getting Started on Arch Linux
4747
-----------------------------
4848

4949
Install the following packages:
5050

51-
pacman -S make texlive-latexextra texlive-binextra texlive-plaingeneric texlive-fontsrecommended
51+
``pacman -S make texlive-latexextra texlive-binextra texlive-plaingeneric texlive-fontsrecommended``
5252

5353
-----------------------------
5454
Getting Started on Microsoft Windows
@@ -59,6 +59,10 @@ See `sample instructions <https://bennierobinson.com/programming/2016/01/24/perl
5959

6060
Install `MiKTeX <https://miktex.org/download>`_
6161

62+
Alternatively, you can `install WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_
63+
and a Linux distribution,
64+
and follow the instructions for Linux above.
65+
6266
------------
6367
Instructions
6468
------------
@@ -80,6 +84,22 @@ For example::
8084

8185
make figvirt.pdf
8286

87+
Verifying input and output when making changes
88+
==============================================
89+
90+
While in the ``source`` directory,
91+
you can check for common mistakes such as misaligned comments with::
92+
93+
../tools/check-source.sh
94+
95+
After typesetting the document,
96+
you can also check the output for further problems with::
97+
98+
../tools/check-output.sh
99+
100+
GitHub Actions will also run these checks when you create a pull request,
101+
but it's often faster if you run them locally first.
102+
83103
----------------
84104
Acknowledgements
85105
----------------

0 commit comments

Comments
 (0)