Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
spamegg1 committed Nov 25, 2024
1 parent 3b072e7 commit 44c3c66
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/workflow.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Build LaTeX document
on: [push]
on: [push, pull_request]
permissions:
contents: write

Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 44c3c66

Please sign in to comment.