From c914e226cf9b21bcb307059ef44ab3ff4b3cb8de Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Thu, 31 Oct 2024 15:39:20 +0100
Subject: add manual plantuml upgrade instructions to readme

---
 readme.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index ece6512..6b578fa 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,29 @@ 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
 
-- 
cgit v1.2.3