add SETUP

1 files changed, 57 insertions, 0 deletions

diff --git a/SETUP.md b/SETUP.md
new file mode 100644
index 0000000..7808edf
--- /dev/null
+++ b/SETUP.md
@@ -0,0 +1,57 @@
+# Setting up environment for building thoughtroam assets
+
+## System requirements
+
+### Debian
+
+Install required packages:
+
+```
+sudo apt install texlive-luatex texlive-binaries-sse2 texlive-lang-european texlive-latex-extra texlive-fonts-extra
+sudo apt install git make citation-style-language-styles plantuml inkscape latexdiff
+```
+
+### Quarto
+
+Download and install newest stable version of Quarto
+from [their website](https://quarto.org/docs/get-started/).
+
+### hedgedoc-cli
+
+Clone code project hedgedoc-cli:
+
+```
+mkdir --parents ~/Projects
+cd ~/Projects
+git clone https://github.com/hedgedoc/cli hedgedoc-cli
+```
+
+Link to cloned CLI script from personal bin folder:
+
+```
+mkdir --parents ~/bin
+cd ~/bin
+ln --symbolic --target-directory=. ../Projects/hedgedoc-cli/bin/hedgedoc
+```
+
+### Fonts
+
+Install fonts included with project.
+
+```
+mkdir --parents ~/.fonts
+cp --target-directory ~/.fonts fonts/*/opentype/*
+```
+
+### PlantUML
+
+Download newest version of PlantUML
+from [their website](https://plantuml.com/download).
+
+Replace Debian-packaged plantuml with the downloaded file:
+
+```
+sudo mv /usr/share/plantuml/plantuml.jar /usr/share/plantuml/plantuml.jar.orig
+sudo cp ~/Downloads/plantuml-1.2024.3.jar /usr/share/plantuml/plantuml.jar
+udo chown root: /usr/share/plantuml/plantuml.jar
+```