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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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
28 changes: 24 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,31 +24,31 @@ Install the `MacTeX distribution <http://tug.org/mactex/>`_.
If you are on a slow network, you'll want to get the `BasicTeX package <http://tug.org/mactex/morepackages.html>`_ instead,
then run the following command to install the other packages that the draft requires:

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

---------------------------------------
Getting Started on Debian-based Systems
---------------------------------------

Install the following packages:

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

-------------------------
Getting Started on Fedora
-------------------------

Install the following packages:

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

-----------------------------
Getting Started on Arch Linux
-----------------------------

Install the following packages:

pacman -S make texlive-latexextra texlive-binextra texlive-plaingeneric texlive-fontsrecommended
``pacman -S make texlive-latexextra texlive-binextra texlive-plaingeneric texlive-fontsrecommended``

-----------------------------
Getting Started on Microsoft Windows
Expand All @@ -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
Loading