Skip to content

Commit 601bc80

Browse files
authored
[README] Mention check-{source,output}.sh tools and WSL
1 parent 103dddc commit 601bc80

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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)