From 44c3c66ab15a92f21aa0d3d828aa0a42e4670fe5 Mon Sep 17 00:00:00 2001 From: spamegg Date: Mon, 25 Nov 2024 23:08:15 +0300 Subject: [PATCH] update README --- .github/workflows/workflow.yml | 2 +- README.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml index c21746e..88edc3a 100644 --- a/.github/workflows/workflow.yml +++ b/.github/workflows/workflow.yml @@ -1,5 +1,5 @@ name: Build LaTeX document -on: [push] +on: [push, pull_request] permissions: contents: write diff --git a/README.md b/README.md index 9fafa42..9da25d2 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,17 @@ Contact me: `spamegg1` on Discord, or [on Slack](https://join.slack.com/t/spameg ## Contributing Only edit the `Epp.tex` source file, I use Github Actions to compile and release the PDF file automatically. + So, you do not have to include your compiled PDF in your pull requests. +### Compiling locally + +You don't need to do this for contributing, Github actions will take care of it for you on pull requests. + +But if you are compiling locally, you'll need: + +- a full [TeXlive](https://www.tug.org/texlive/) installation (you do need the *full* thing, I use some rare / obscure packages), and +- since I am using [minted](https://github.com/gpoore/minted) for syntax highlighting some code, you'll have to pass the [`-shell-escape` argument](https://tex.stackexchange.com/questions/598818/how-can-i-enable-shell-escape#598819) to `latexmk` for the compilation. + [cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/ [cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg