Skip to content

Commit 44c3c66

Browse files
committed
update README
1 parent 3b072e7 commit 44c3c66

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

.github/workflows/workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Build LaTeX document
2-
on: [push]
2+
on: [push, pull_request]
33
permissions:
44
contents: write
55

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,17 @@ Contact me: `spamegg1` on Discord, or [on Slack](https://join.slack.com/t/spameg
2323
## Contributing
2424

2525
Only edit the `Epp.tex` source file, I use Github Actions to compile and release the PDF file automatically.
26+
2627
So, you do not have to include your compiled PDF in your pull requests.
2728

29+
### Compiling locally
30+
31+
You don't need to do this for contributing, Github actions will take care of it for you on pull requests.
32+
33+
But if you are compiling locally, you'll need:
34+
35+
- a full [TeXlive](https://www.tug.org/texlive/) installation (you do need the *full* thing, I use some rare / obscure packages), and
36+
- 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.
37+
2838
[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/
2939
[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg

0 commit comments

Comments
 (0)