aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-02 20:54:03 +0100
committerWBoerenkamps <wrj.boerenkamps@student.avans.nl>2024-11-02 20:54:03 +0100
commit291b1c68f454230b050cb9651c980d08c517c5b6 (patch)
treead47c420532c441d02256b0d2c8d148ea94599b1 /readme.md
parentcf7a38d87164a9be78efd8c045acd43422a1be04 (diff)
parent0cfe85c3a8766992f9b04c082143283698d756d7 (diff)
Merge branch 'master' of https://github.com/lonkaars/crepe-docs into wouter/gameloop-design
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index ece6512..858d319 100644
--- a/readme.md
+++ b/readme.md
@@ -11,7 +11,7 @@ snippets for specific formatting.
Prerequisites:
- A LaTeX distribution that includes XeLaTeX and latexmk
-- PlantUML
+- PlantUML ([1.2024.7 or later](#plantuml)!)
- Python 3
- Fonts (see see [style.md](./style.md) for download links)
@@ -33,7 +33,30 @@ additional configuration files for the following editors:
- `sources.bib` contains all bibliography entries / references
- `glossary.bib` contains all glossary entries
+## PlantUML
+
+To check if your PlantUML version is recent enough, run:
+```
+$ plantuml -version
+```
+
+To upgrade PlantUML manually, download the latest (GPL) \.jar from
+[here][plantuml], and overwrite the \.jar file installed by your package
+manager:
+
+```
+$ curl -sLo- https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-1.2024.7.jar > plantuml.jar
+# mv plantuml.jar /usr/share/plantuml/plantuml.jar
+```
+
+> [!NOTE]
+> Ubuntu, Debian and Mint all place PlantUML's \.jar file under
+> `/usr/share/plantuml/plantuml.jar`, while it's under
+> `/usr/share/java/plantuml/plantuml.jar` on Arch. Check the contents of the
+> file returned by `command -v plantuml` to confirm this.
+
[vscode]: https://code.visualstudio.com
[latexworkshop]: https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop
[vimtex]: https://github.com/lervag/vimtex
+[plantuml]: https://plantuml.com/en/download