Skip to content

Update README.rst #7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2025
Merged

Update README.rst #7894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ See `sample instructions <https://bennierobinson.com/programming/2016/01/24/perl

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

Alternatively, you can `install WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_
and a Linux distribution,
and follow the instructions for Linux above.

------------
Instructions
------------
Expand All @@ -80,6 +84,22 @@ For example::

make figvirt.pdf

Verifying input and output when making changes
==============================================

While in the ``source`` directory,
you can check for common mistakes such as misaligned comments with::

../tools/check-source.sh

After typesetting the document,
you can also check the output for further problems with::

../tools/check-output.sh

GitHub Actions will also run these checks when you create a pull request,
but it's often faster if you run them locally first.

----------------
Acknowledgements
----------------
Expand Down